shadowfacts/fonttools
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
11,983 Commits 1 Branch 0 Tags
Commit Graph

19 Commits

Author SHA1 Message Date
Nathan Williis
c6c9ea405e Docs: use by-source order for autodoc consistently. 2024-09-16 12:59:30 +01:00
Nathan Williis
e1b51fb7c4 Docs: set default highlight language to Python. 2024-09-16 12:49:12 +01:00
Nathan Williis
cd1c31ff6c Docs: reorder Sphinx extensions. Napoleon must precede autodoc or it will trigger superfluous warnings about indentation. 2024-09-02 17:13:48 +01:00
Nathan Williis
1781cf8f75 Docs, minor: reformat line for lint GH action. 2024-08-20 17:00:52 +01:00
Nathan Williis
6f7d949d5c Docs: update Sphinx config, to show inheritance. This should simplify cross-module readability, and also makes errors caused by autodoc easier to spot. 2024-08-20 16:14:46 +01:00
Nikolaus Waxweiler
d584daa8fd Blacken code 2022-12-13 11:26:36 +00:00
Simon Cozens
0f03e6529a
[docs] Fix sphinx warnings (#2453) 
* Add default auto doc options

* Ensure all references are unique

* Use anonymous links to avoid duplicate references

* Remove default options, fix wrong module name

* Don’t index repeated class

* Remove repeated classes included through automodule

* Fix warnings

* We don’t use our own static directory

* Correctly format XML in docs

* Fix indentation

* Fix overline

* Bring TOC to top

* Fix definition list

* Offset definition lists and examples

* Fix erroneous markup

* Fix markup

* Already included in automodule

* Fix args markup

* Correct markup for example

* Don’t reindex repeated module

* Correct XML code block markup

* Fix markup errors, change example to doctest

* Correct list markup

* Make ttx docstring both valid RST and valid help output

* Various other boring markup fixes

* Fix example indenting

* Make docstring valid RST and valid help output

* Mock import for reportlab

* It’s ok if manual links don’t appear in toctrees

* Oops typo, I guess doctests are useful
 2021-12-02 15:31:49 +00:00
Simon Cozens
e0dc30aa2d
[docs] Improve documentation for fontTools.ttLib.ttFont (#2442) 2021-11-18 13:06:02 +00:00
Simon Cozens
7b894956d5 [doc] Add a doc coverage report 
So we know how bad things are
 2020-05-03 22:03:26 +01:00
Chris Simpkins
566d50162d
[Doc/source/conf.py] configuration updates 2020-04-20 16:24:35 -04:00
Chris Simpkins
5cba1d89f2
[docs/source/conf.py] update sphinx docs build config 2020-04-20 13:35:33 -04:00
Chris Simpkins
7916ea8f5c
[docs] convert to built-in Napoleon Sphinx extension 
available in Sphinx v1.3+
 2020-04-19 14:29:18 -04:00
Chris Simpkins
aa5b57277a
[Doc] added CC BY-SA 4.0 license to documentation 2020-04-19 14:29:18 -04:00
Chris Simpkins
19c4b79664
[Doc] conf.py - do not display version number 2020-04-19 14:29:18 -04:00
Chris Simpkins
772eae9727
[Doc] conf.py - convert to RTD default theme for local builds 2020-04-19 14:29:18 -04:00
Chris Simpkins
25249b7dcb
[Doc] conf.py - update fontTools version 2020-04-19 14:29:18 -04:00
Chris Simpkins
7de4e9409a
[Doc] conf.py - add napoleon docstring parser extension support 2020-04-19 14:29:18 -04:00
Chris Simpkins
56ac60e761
[Doc] blacken conf.py 2020-04-19 14:29:18 -04:00
Gustavo Ferreira
9eae1bd2e0 setting up Sphinx-based autodocs 2017-04-21 19:47:28 -03:00