From dbef683624af1b6e808c8b33851b02efedf6490f Mon Sep 17 00:00:00 2001 From: Jany Belluz Date: Thu, 14 Apr 2022 15:23:38 +0100 Subject: [PATCH] [config] Add documentation --- .gitignore | 3 +++ Doc/source/config.rst | 8 ++++++++ Doc/source/index.rst | 4 +++- Doc/source/misc/configTools.rst | 8 ++++++++ Doc/source/misc/index.rst | 1 + 5 files changed, 23 insertions(+), 1 deletion(-) create mode 100644 Doc/source/config.rst create mode 100644 Doc/source/misc/configTools.rst diff --git a/.gitignore b/.gitignore index 9c564fd54..e62c33dd3 100644 --- a/.gitignore +++ b/.gitignore @@ -58,3 +58,6 @@ Lib/**/*.c # Ctags tags + +# Documentation +Doc/source/_build diff --git a/Doc/source/config.rst b/Doc/source/config.rst new file mode 100644 index 000000000..6be575d5e --- /dev/null +++ b/Doc/source/config.rst @@ -0,0 +1,8 @@ +########################### +config: configure fontTools +########################### + +.. automodule:: fontTools.config + :inherited-members: + :members: + :undoc-members: diff --git a/Doc/source/index.rst b/Doc/source/index.rst index 784834d83..571ef8ddf 100644 --- a/Doc/source/index.rst +++ b/Doc/source/index.rst @@ -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 \ No newline at end of file + :target: https://gitter.im/fonttools-dev/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge diff --git a/Doc/source/misc/configTools.rst b/Doc/source/misc/configTools.rst new file mode 100644 index 000000000..1d9354119 --- /dev/null +++ b/Doc/source/misc/configTools.rst @@ -0,0 +1,8 @@ +########### +configTools +########### + +.. automodule:: fontTools.misc.configTools + :inherited-members: + :members: + :undoc-members: diff --git a/Doc/source/misc/index.rst b/Doc/source/misc/index.rst index 003c48a5f..cfe520557 100644 --- a/Doc/source/misc/index.rst +++ b/Doc/source/misc/index.rst @@ -12,6 +12,7 @@ utilities by fontTools, but some of which may be more generally useful. bezierTools classifyTools cliTools + configTools eexec encodingTools etree