[docs] Source documentation for cffLib (#1935)

* [docs] Source documentation for cffLib * Address feedback
fonttools · May 14, 2020 · 8d32a24 · 8d32a24
1 parent 847c31c
commit 8d32a24
Show file tree

Hide file tree

Showing 6 changed files with 277 additions and 44 deletions.
diff --git a/Doc/source/cffLib/index.rst b/Doc/source/cffLib/index.rst
@@ -1,14 +1,53 @@
-######
-cffLib
-######
+##################################
+cffLib: read/write Adobe CFF fonts
+##################################
+
+.. automodule:: fontTools.cffLib
+
+This package also contains two modules for manipulating CFF format glyphs:
 
 .. toctree::
    :maxdepth: 1
 
    specializer
    width
 
-.. automodule:: fontTools.cffLib
+.. autoclass:: fontTools.cffLib.CFFFontSet
    :inherited-members:
    :members:
-   :undoc-members:
+
+.. autoclass:: fontTools.cffLib.TopDict
+   :members:
+
+.. autoclass:: fontTools.cffLib.CharStrings
+   :members:
+
+.. autoclass:: fontTools.cffLib.Index
+   :members:
+
+.. autoclass:: fontTools.cffLib.GlobalSubrsIndex
+   :members:
+
+.. autoclass:: fontTools.cffLib.TopDictIndex
+   :members:
+
+.. autoclass:: fontTools.cffLib.CFFWriter
+   :members:
+
+.. autoclass:: fontTools.cffLib.IndexCompiler
+   :members:
+
+.. autoclass:: fontTools.cffLib.TopDictIndexCompiler
+   :members:
+
+.. autoclass:: fontTools.cffLib.FDArrayIndexCompiler
+   :members:
+
+.. autoclass:: fontTools.cffLib.GlobalSubrsCompiler
+   :members:
+
+.. autoclass:: fontTools.cffLib.SubrsCompiler
+   :members:
+
+.. autoclass:: fontTools.cffLib.CharStringsCompiler
+   :members:
diff --git a/Doc/source/cffLib/specializer.rst b/Doc/source/cffLib/specializer.rst
@@ -1,6 +1,6 @@
-###########
-specializer
-###########
+##############################################################
+specializer: T2CharString operator specializer and generalizer
+##############################################################
 
 .. automodule:: fontTools.cffLib.specializer
    :inherited-members:

diff --git a/Doc/source/cffLib/width.rst b/Doc/source/cffLib/width.rst
@@ -1,8 +1,6 @@
-#####
-width
-#####
+#########################################
+width: T2CharString glyph width optimizer
+#########################################
 
 .. automodule:: fontTools.cffLib.width
-   :inherited-members:
-   :members:
-   :undoc-members:
+   :members: optimizeWidths, optimizeWidthsBruteforce