[docs] Reorganise colorLib docs (#1936)

Does not add any new documentation (there is already some documentation for user-facing functions). It just makes colorLib.builder the top-level documentation entry, because that’s the part the user needs to care about.
fonttools · May 12, 2020 · a114ec2 · a114ec2
1 parent 94cb175
commit a114ec2
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 26 deletions.
diff --git a/Doc/source/colorLib/builder.rst b/Doc/source/colorLib/builder.rst
diff --git a/Doc/source/colorLib/errors.rst b/Doc/source/colorLib/errors.rst
diff --git a/Doc/source/colorLib/index.rst b/Doc/source/colorLib/index.rst
@@ -1,14 +1,11 @@
-########
-colorLib
-########
+#####################################################
+colorLib.builder: Build COLR/CPAL tables from scratch
+#####################################################
 
-.. toctree::
-   :maxdepth: 1
+.. automodule:: fontTools.colorLib.builder
+   :members: buildCPAL, buildCOLR, populateCOLRv0
 
-   builder
-   errors
-
-.. automodule:: fontTools.colorLib
+.. autoclass:: fontTools.colorLib.builder.ColorPaletteType
    :inherited-members:
    :members:
-   :undoc-members:
+   :undoc-members:
diff --git a/Lib/fontTools/colorLib/builder.py b/Lib/fontTools/colorLib/builder.py
@@ -1,3 +1,7 @@
+"""
+colorLib.builder: Build COLR/CPAL tables from scratch
+
+"""
 import collections
 import copy
 import enum