[config] Add documentation

This commit is contained in:
Jany Belluz 2022-04-14 15:23:38 +01:00
parent 268fbac85c
commit dbef683624
5 changed files with 23 additions and 1 deletions

3
.gitignore vendored
View File

@ -58,3 +58,6 @@ Lib/**/*.c
# Ctags
tags
# Documentation
Doc/source/_build

8
Doc/source/config.rst Normal file
View File

@ -0,0 +1,8 @@
###########################
config: configure fontTools
###########################
.. automodule:: fontTools.config
:inherited-members:
:members:
:undoc-members:

View File

@ -69,6 +69,7 @@ libraries in the fontTools suite:
- :py:mod:`fontTools.agl`: Access to the Adobe Glyph List
- :py:mod:`fontTools.cffLib`: Read/write tools for Adobe CFF fonts
- :py:mod:`fontTools.colorLib`: Module for handling colors in CPAL/COLR fonts
- :py:mod:`fontTools.config`: Configure fontTools
- :py:mod:`fontTools.cu2qu`: Module for cubic to quadratic conversion
- :py:mod:`fontTools.designspaceLib`: Read and write designspace files
- :py:mod:`fontTools.encodings`: Support for font-related character encodings
@ -120,6 +121,7 @@ Table of Contents
agl
cffLib/index
colorLib/index
config
cu2qu/index
designspaceLib/index
encodings/index
@ -152,4 +154,4 @@ Table of Contents
:target: https://pypi.org/project/FontTools
.. |Gitter Chat| image:: https://badges.gitter.im/fonttools-dev/Lobby.svg
:alt: Join the chat at https://gitter.im/fonttools-dev/Lobby
:target: https://gitter.im/fonttools-dev/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
:target: https://gitter.im/fonttools-dev/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge

View File

@ -0,0 +1,8 @@
###########
configTools
###########
.. automodule:: fontTools.misc.configTools
:inherited-members:
:members:
:undoc-members:

View File

@ -12,6 +12,7 @@ utilities by fontTools, but some of which may be more generally useful.
bezierTools
classifyTools
cliTools
configTools
eexec
encodingTools
etree