14 Commits

Author SHA1 Message Date
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
a0d6ca3b76 ReStructuredText nits 2021-03-03 13:33:58 +00:00
Simon Cozens
516d0f7dfe Add definitions for varLib-specific terms 2021-03-03 12:57:52 +00:00
Chris Simpkins
e86f965bb5
[Doc varLib] add missing varLib module documentation 2020-04-20 18:40:51 -04:00
Chris Simpkins
5ec8d924c0
[Doc] remove varLib.designspace documentation
the module was removed from the source
2020-04-19 14:29:18 -04:00
Chris Simpkins
d0cdffe437
[Doc] add inherited member docstring parsing support 2020-04-19 14:29:18 -04:00
Chris Simpkins
481bc9e912
[Doc] add varLib.varStore documentation 2020-04-19 14:29:18 -04:00
Chris Simpkins
db06df1622
[Doc] add varLib.plot documentation 2020-04-19 14:29:18 -04:00
Chris Simpkins
2478e88e88
[Doc] add varLib.mvar documentation 2020-04-19 14:29:18 -04:00
Chris Simpkins
eef84ad95d
[Doc] add varLib.iup documentation 2020-04-19 14:29:18 -04:00
Chris Simpkins
7e027c8643
[Doc] add varLib.featureVars documentation 2020-04-19 14:29:18 -04:00
Chris Simpkins
85b2e21604
[Doc] add varLib.builder documentation 2020-04-19 14:29:18 -04:00
Chris Simpkins
e1c373d03a
[Doc] update varLib TOC 2020-04-19 14:29:18 -04:00
Gustavo Ferreira
9eae1bd2e0 setting up Sphinx-based autodocs 2017-04-21 19:47:28 -03:00