From 69cecfaa1044ec424fc89c8b807f0140be50bf56 Mon Sep 17 00:00:00 2001 From: Nathan Williis Date: Tue, 17 Sep 2024 17:23:44 +0100 Subject: [PATCH] Docs: cffLib, minor updates. --- Doc/source/cffLib/CFF2ToCFF.rst | 3 +++ Doc/source/cffLib/CFFToCFF2.rst | 1 + Doc/source/cffLib/index.rst | 44 +++++++++++++++++++++---------- Doc/source/cffLib/specializer.rst | 8 ++++++ Lib/fontTools/cffLib/__init__.py | 4 +-- 5 files changed, 44 insertions(+), 16 deletions(-) diff --git a/Doc/source/cffLib/CFF2ToCFF.rst b/Doc/source/cffLib/CFF2ToCFF.rst index 04c8b1f28..28719cafe 100644 --- a/Doc/source/cffLib/CFF2ToCFF.rst +++ b/Doc/source/cffLib/CFF2ToCFF.rst @@ -5,3 +5,6 @@ CFF2ToCFF: convert CFF2 to CFF .. automodule:: fontTools.cffLib.CFF2ToCFF :inherited-members: :members: + :undoc-members: + + diff --git a/Doc/source/cffLib/CFFToCFF2.rst b/Doc/source/cffLib/CFFToCFF2.rst index 7ea2183d9..3fb0f20b3 100644 --- a/Doc/source/cffLib/CFFToCFF2.rst +++ b/Doc/source/cffLib/CFFToCFF2.rst @@ -5,3 +5,4 @@ CFFToCFF2: convert CFF to CFF2 .. automodule:: fontTools.cffLib.CFFToCFF2 :inherited-members: :members: + :undoc-members: diff --git a/Doc/source/cffLib/index.rst b/Doc/source/cffLib/index.rst index df9d47ba6..c4c39c1e7 100644 --- a/Doc/source/cffLib/index.rst +++ b/Doc/source/cffLib/index.rst @@ -2,21 +2,37 @@ cffLib: Read and write Adobe CFF fonts ###################################### -This package contains modules for converting between CCF and CFF2: +.. rubric:: Overview: + :heading-level: 3 -.. toctree:: - :maxdepth: 1 - - CFFToCFF2 - CFF2ToCFF - -and modules for manipulating CFF format glyphs: - -.. toctree:: - :maxdepth: 1 - - specializer - width .. automodule:: fontTools.cffLib + :inherited-members: + :members: + :undoc-members: + :member-order: bysource + .. rubric:: Submodules: + :heading-level: 3 + + cffLib contains submodules for converting between CCF and CFF2. + Each can be used within other Python code or run as a + command-line console script: + + .. toctree:: + :maxdepth: 1 + + CFFToCFF2 + CFF2ToCFF + + It also contains submodules for manipulating CFF-formatted glyphs: + + .. toctree:: + :maxdepth: 1 + + specializer + width + + .. rubric:: Module members: + :heading-level: 3 + diff --git a/Doc/source/cffLib/specializer.rst b/Doc/source/cffLib/specializer.rst index 016a89621..b14f56ca3 100644 --- a/Doc/source/cffLib/specializer.rst +++ b/Doc/source/cffLib/specializer.rst @@ -2,7 +2,15 @@ specializer: T2CharString operator specializer and generalizer ############################################################## +.. rubric:: Overview: + :heading-level: 3 + .. automodule:: fontTools.cffLib.specializer :inherited-members: :members: :undoc-members: + + + .. rubric:: Module members: + :heading-level: 3 + diff --git a/Lib/fontTools/cffLib/__init__.py b/Lib/fontTools/cffLib/__init__.py index c192ec77a..2f47d9006 100644 --- a/Lib/fontTools/cffLib/__init__.py +++ b/Lib/fontTools/cffLib/__init__.py @@ -1,7 +1,7 @@ """cffLib: read/write Adobe CFF fonts -OpenType fonts with PostScript outlines contain a completely independent -font file, Adobe's *Compact Font Format*. So dealing with OpenType fonts +OpenType fonts with PostScript outlines embed a completely independent +font file in Adobe's *Compact Font Format*. So dealing with OpenType fonts requires also dealing with CFF. This module allows you to read and write fonts written in the CFF format.