diff --git a/Doc/source/afmLib.rst b/Doc/source/afmLib.rst index bea783d7a..7e233698c 100644 --- a/Doc/source/afmLib.rst +++ b/Doc/source/afmLib.rst @@ -2,7 +2,14 @@ afmLib: Read and write Adobe Font Metrics files ############################################### +.. rubric:: Overview: + :heading-level: 2 + .. automodule:: fontTools.afmLib + :members: + :undoc-members: -.. autoclass:: fontTools.afmLib.AFM - :members: + + .. rubric:: Module members: + :heading-level: 2 + diff --git a/Doc/source/agl.rst b/Doc/source/agl.rst index 6e89857f4..aff58a362 100644 --- a/Doc/source/agl.rst +++ b/Doc/source/agl.rst @@ -2,5 +2,15 @@ agl: Interface to the Adobe Glyph List ###################################### +.. rubric:: Overview: + :heading-level: 2 + .. automodule:: fontTools.agl - :members: toUnicode, UV2AGL, AGL2UV + :members: + :undoc-members: + :member-order: bysource + + + .. rubric:: Module members: + :heading-level: 2 + diff --git a/Doc/source/conf.py b/Doc/source/conf.py index 0f56c6e1e..4879ab301 100644 --- a/Doc/source/conf.py +++ b/Doc/source/conf.py @@ -38,15 +38,19 @@ extensions = [ "sphinx.ext.autosectionlabel", ] -autodoc_mock_imports = ["gtk", "reportlab"] +autodoc_mock_imports = ["gtk", "reportlab", "Quartz"] autodoc_default_options = { "members": True, - "inherited-members": True, + "inherited-members": False, "show-inheritance": True, "member-order": "bysource", } +# This option allows show-inheritace to work but not clutter up the output +# with the (surplus) full inheritance stack. +autodoc_inherit_docstrings = False + # Add any paths that contain templates here, relative to this directory. templates_path = ["_templates"] diff --git a/Doc/source/config.rst b/Doc/source/config.rst index 40d1a6ae6..0b98d6683 100644 --- a/Doc/source/config.rst +++ b/Doc/source/config.rst @@ -3,6 +3,5 @@ config: Configure fontTools ########################### .. automodule:: fontTools.config - :inherited-members: :members: :undoc-members: diff --git a/Doc/source/index.rst b/Doc/source/index.rst index e74abf219..e98d902a2 100644 --- a/Doc/source/index.rst +++ b/Doc/source/index.rst @@ -87,12 +87,10 @@ License fontTools is licensed under the `MIT license `_. Refer to the full text of the license for details. -Table of Contents ------------------ .. toctree:: - :maxdepth: 2 - :caption: Library + :maxdepth: 1 + :hidden: afmLib agl @@ -108,6 +106,7 @@ Table of Contents mtiLib otlLib/index pens/index + qu2cu/index subset/index svgLib/index t1Lib @@ -115,7 +114,6 @@ Table of Contents ttLib/index ttx ufoLib/index - unicode unicodedata/index varLib/index voltLib/index diff --git a/Doc/source/merge.rst b/Doc/source/merge.rst index 311461557..819f6ea7e 100644 --- a/Doc/source/merge.rst +++ b/Doc/source/merge.rst @@ -2,9 +2,12 @@ merge: Merge multiple fonts into one #################################### -``fontTools.merge`` provides both a library and a command line interface +.. rubric:: Overview: + :heading-level: 2 + +:mod:`fontTools.merge` provides both a library and a command line interface (``fonttools merge``) for merging multiple fonts together. .. autoclass:: fontTools.merge.Merger - :inherited-members: :members: + :undoc-members: diff --git a/Doc/source/mtiLib.rst b/Doc/source/mtiLib.rst index 1bf74e189..d90bd9b72 100644 --- a/Doc/source/mtiLib.rst +++ b/Doc/source/mtiLib.rst @@ -2,13 +2,27 @@ mtiLib: Read Monotype FontDame source files ########################################### -FontTools provides support for reading the OpenType layout tables produced by +.. rubric:: Overview + :heading-level: 2 + +FontTools provides support for reading the OpenType Layout tables produced by Monotype's FontDame and Font Chef font editors. These tables are written in a -simple textual format. The ``mtiLib`` library parses these text files and creates +simple textual format. The :py:mod:`mtiLib` library parses these text files and creates table objects representing their contents. -Additionally, ``fonttools mtiLib`` will convert a text file to TTX XML. +Additionally, running the ``fonttools mtiLib`` command will convert a text file to TTX XML. +.. rubric:: Module members: + :heading-level: 2 + + +.. autofunction:: fontTools.mtiLib.build + +.. autofunction:: fontTools.mtiLib.main + + .. automodule:: fontTools.mtiLib - :members: build, main + :members: + :undoc-members: + :exclude-members: build, main diff --git a/Doc/source/qu2cu/cli.rst b/Doc/source/qu2cu/cli.rst new file mode 100644 index 000000000..25c5fb78b --- /dev/null +++ b/Doc/source/qu2cu/cli.rst @@ -0,0 +1,13 @@ +################################################### +cli: Quadratic-to-cubic converter command-line tool +################################################### + +.. rubric:: Overview: + :heading-level: 2 + +.. automodule:: fontTools.qu2cu.cli + :members: + :undoc-members: + + .. rubric:: Module members: + :heading-level: 2 diff --git a/Doc/source/qu2cu/index.rst b/Doc/source/qu2cu/index.rst new file mode 100644 index 000000000..4a64b743f --- /dev/null +++ b/Doc/source/qu2cu/index.rst @@ -0,0 +1,38 @@ +######################################## +qu2cu: Convert quadratic curves to cubic +######################################## + +.. rubric:: Overview + :heading-level: 2 + + +Routines for converting quadratic curves to cubic splines, suitable for use +in TrueType to CFF-flavored OpenType outline conversion. + +The basic curve conversion routines are implemented in the +:mod:`fontTools.qu2cu.qu2cu` module. + +.. note:: The redundancy in the module name is a workaround made + made necessary by :mod:`fontTools.qu2cu`'s usage of + `Cython `_. Providing Cython support + for the module enables faster execution on systems where + Cython is available. However, the module remains fully + available on systems without Cython, too. + +.. automodule:: fontTools.qu2cu.qu2cu + :members: + :undoc-members: + + qu2cu also includes a submodule that implements the + ``fonttools qu2cu`` command for converting a UFO format font with + quadratic curves into one with cubic curves: + + .. toctree:: + :maxdepth: 1 + + cli + + + .. rubric:: Package contents + :heading-level: 2 + diff --git a/Doc/source/t1Lib.rst b/Doc/source/t1Lib.rst index 2a8c3fc3b..b9a8a8ea6 100644 --- a/Doc/source/t1Lib.rst +++ b/Doc/source/t1Lib.rst @@ -2,7 +2,17 @@ t1Lib: Read and write PostScript Type 1 fonts ############################################# +.. rubric:: Overview: + :heading-level: 2 + +Note also that :mod:`t1Lib` supports some :doc:`optional ` +external libraries. + .. automodule:: fontTools.t1Lib - :inherited-members: :members: :undoc-members: + + + .. rubric:: Module members: + :heading-level: 2 + diff --git a/Doc/source/tfmLib.rst b/Doc/source/tfmLib.rst index daa4125c2..7e3a61265 100644 --- a/Doc/source/tfmLib.rst +++ b/Doc/source/tfmLib.rst @@ -2,7 +2,18 @@ tfmLib: Read TeX Font Metrics files ########################################### -.. automodule:: fontTools.tfmLib +.. rubric:: Overview + :heading-level: 2 -.. autoclass:: fontTools.tfmLib.TFM - :members: + +.. automodule:: fontTools.tfmLib + :members: TFM + :undoc-members: + :exclude-members: TFMException + + + .. rubric:: Module contents: + :heading-level: 2 + + +.. autoexception:: fontTools.tfmLib.TFMException diff --git a/Doc/source/ttx.rst b/Doc/source/ttx.rst index c05c8df05..62b91b45d 100644 --- a/Doc/source/ttx.rst +++ b/Doc/source/ttx.rst @@ -57,6 +57,5 @@ It is possible that different glyphs use the same name. If this happens, we forc Because the order in which glyphs are stored inside the binary font is important, we maintain an ordered list of glyph names in the font. .. automodule:: fontTools.ttx - :inherited-members: :members: :undoc-members: diff --git a/Doc/source/unicode.rst b/Doc/source/unicode.rst index 65481d58f..228e7d506 100644 --- a/Doc/source/unicode.rst +++ b/Doc/source/unicode.rst @@ -1,8 +1,20 @@ +:orphan: + ####### unicode ####### +.. rubric:: Overview: + :heading-level: 2 + +The :mod:`fonttools.unicode` module is a helper for +:mod:`fontTools.ttx` that provides access to Unicode data and manages +fallback support. + +Note also that :mod:`unicode` supports some :doc:`optional ` +external libraries. + + .. automodule:: fontTools.unicode - :inherited-members: :members: :undoc-members: