16 Commits

Author SHA1 Message Date
Nathan Williis
d80b8dbc89 Docs, minor: add regularized title text to all modules. 2024-09-16 12:48:15 +01:00
Nathan Williis
6ec2b67152 Remove duplicate sidebar entries for ttLib.ttFont.TTFont and .GlyphOrder. 2024-08-15 11:32:05 +01:00
Simon Cozens
3e0caa881e
[docs] Fully document the glyf table (#2457)
* Fully document the glyf table

* Correct docs for getGlyphName/getGlyphId

* Fix typo

* Grammar nits
2021-12-02 15:32:20 +00:00
Simon Cozens
f887389d59
[docs] Fully document the cmap table (#2454)
* Fully document the cmap table

* Try not to completely break cmap handling while writing docs, Simon
2021-12-02 15:32:03 +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
00f37ea6b6
[docs] Split table docs into individual pages (#2444) 2021-11-18 09:01:27 +00:00
Simon Cozens
9cb126b10a Document expected arguments for _TTGlyphSet, _TTGlyph and TTGlyphPen 2021-02-08 11:30:39 +00:00
Chris Simpkins
cfbe69fe7f
fix table doc paths to address autodoc import failures 2020-04-22 00:07:48 -04:00
Chris Simpkins
8c691d3d44
[Docs ttLib/tables] add all missing tables, add docs on how to implement own table converter 2020-04-20 18:25:09 -04:00
Chris Simpkins
d0cdffe437
[Doc] add inherited member docstring parsing support 2020-04-19 14:29:18 -04:00
Chris Simpkins
eeefd529f6
[Doc] update ttLib TOC with new doc files 2020-04-19 14:29:18 -04:00
Chris Simpkins
9d8904a8f4
[Doc] add ttLib.ttCollection documentation 2020-04-19 14:29:18 -04:00
Chris Simpkins
d6baf0bfdd
[Doc] add ttLib.standardGlyphOrder documentation 2020-04-19 14:29:18 -04:00
Chris Simpkins
b4b99dbd3a
[Doc] add ttLib.ttFont documentation 2020-04-19 14:29:18 -04:00
Gustavo Ferreira
9eae1bd2e0 setting up Sphinx-based autodocs 2017-04-21 19:47:28 -03:00