17 Commits

Author SHA1 Message Date
Jany Belluz
dbef683624 [config] Add documentation 2022-04-14 15:23:38 +01: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
Khaled Hosny
5e3774bd7b Remove py23 from the documentation
We don’t want anyone to use it anymore.
2021-08-20 01:31:50 +02:00
Simon Cozens
775dc6074e
fontTools.misc.* documentation, part 2 (#1981)
* Document misc.filenames
* Document misc.fixedTools
* Document misc.intTools
* Document misc.loggingTools
* Document misc.macCreatorType
* Document misc.macRes
* Document misc.plistlib
2020-06-08 15:53:48 +01:00
Simon Cozens
76902b7129
[docs] fontTools.misc.* part 1 (#1956)
* Document misc.arrayTools
* Document misc.bezierTools
* Document cliTools
* Document eexec
2020-05-19 09:51:17 +01:00
Chris Simpkins
cff2fb3b99
add missing documentation modules 2020-04-22 00:07:03 -04:00
Chris Simpkins
d0cdffe437
[Doc] add inherited member docstring parsing support 2020-04-19 14:29:18 -04:00
Chris Simpkins
e4415cf224
[Doc] add misc.symfont documentation 2020-04-19 14:29:18 -04:00
Chris Simpkins
1e1ba80ada
[Doc] add misc.py23 documentation 2020-04-19 14:29:18 -04:00
Chris Simpkins
dc80a4e3f9
[Doc] add misc.psOperators documentation 2020-04-19 14:29:18 -04:00
Chris Simpkins
7ca5f84e5f
[Doc] add misc.psLib documentation 2020-04-19 14:29:18 -04:00
Chris Simpkins
042a595de0
[Doc] add misc.macRes documentation 2020-04-19 14:29:18 -04:00
Chris Simpkins
7cfdddc607
[Doc] add misc.macCreatorType documentation 2020-04-19 14:29:18 -04:00
Chris Simpkins
ea31fc95b7
[Doc] add misc.filenames documentation 2020-04-19 14:29:18 -04:00
Chris Simpkins
a2c694d0c5
[Doc] add misc.cliTools documentation 2020-04-19 14:29:18 -04:00
Chris Simpkins
60e85d2dd5
[Doc] updated misc module documentation 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