6 Commits

Author SHA1 Message Date
Khaled Hosny
e41040bb9d [docs] Add buildMathTable to otlLib.builder documentation 2024-05-30 00:20:04 +03: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
db8948b654 Document otlLib.builder, high-level lookup builders.
Essentially the documentation from #1995, incorporates @dscorbett
feedback.
2020-07-03 11:38:29 +01:00
Chris Simpkins
d0cdffe437
[Doc] add inherited member docstring parsing support 2020-04-19 14:29:18 -04:00
Chris Simpkins
87ad724b18
[Doc] add otlLib.builder documentation 2020-04-19 14:29:18 -04:00
Chris Simpkins
85db649cdc
[Doc] add otlLib documentation 2020-04-19 14:29:18 -04:00