shadowfacts/fonttools
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #3712 from n8willis/master

Browse Source 
[Docs] update Sphinx config
This commit is contained in:
n8willis 2024-12-03 20:37:47 +00:00 committed by GitHub
commit 3ed96c973d
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
13 changed files with 141 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
Doc/source/afmLib.rst
View File

@ -2,7 +2,14 @@
afmLib: Read and write Adobe Font Metrics files
###############################################
.. automodule:: fontTools.afmLib
.. rubric:: Overview:
:heading-level: 2
.. autoclass:: fontTools.afmLib.AFM
.. automodule:: fontTools.afmLib
:members:
:undoc-members:
.. rubric:: Module members:
:heading-level: 2

12
Doc/source/agl.rst
View File

@ -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

8
Doc/source/conf.py
View File

@ -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"]

1
Doc/source/config.rst
View File

@ -3,6 +3,5 @@ config: Configure fontTools
###########################
.. automodule:: fontTools.config
:inherited-members:
:members:
:undoc-members:

8
Doc/source/index.rst
View File

@ -87,12 +87,10 @@ License
fontTools is licensed under the `MIT license <https://github.com/fonttools/fonttools/blob/main/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

7
Doc/source/merge.rst
View File

@ -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:

22
Doc/source/mtiLib.rst
View File

@ -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

13
Doc/source/qu2cu/cli.rst Normal file
View File

@ -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

38
Doc/source/qu2cu/index.rst Normal file
View File

@ -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 <https://cython.org/>`_. 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

12
Doc/source/t1Lib.rst
View File

@ -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 </optional>`
external libraries.
.. automodule:: fontTools.t1Lib
:inherited-members:
:members:
:undoc-members:
.. rubric:: Module members:
:heading-level: 2

17
Doc/source/tfmLib.rst
View File

@ -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

1
Doc/source/ttx.rst
View File

@ -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:

14
Doc/source/unicode.rst
View File

@ -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 </optional>`
external libraries.
.. automodule:: fontTools.unicode
:inherited-members:
:members:
:undoc-members: