From a114ec2c201687a85dd6fa8dcbbeebed597aadb2 Mon Sep 17 00:00:00 2001 From: Simon Cozens Date: Tue, 12 May 2020 11:19:17 +0100 Subject: [PATCH] [docs] Reorganise colorLib docs (#1936) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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. --- Doc/source/colorLib/builder.rst | 8 -------- Doc/source/colorLib/errors.rst | 8 -------- Doc/source/colorLib/index.rst | 17 +++++++---------- Lib/fontTools/colorLib/builder.py | 4 ++++ 4 files changed, 11 insertions(+), 26 deletions(-) delete mode 100644 Doc/source/colorLib/builder.rst delete mode 100644 Doc/source/colorLib/errors.rst diff --git a/Doc/source/colorLib/builder.rst b/Doc/source/colorLib/builder.rst deleted file mode 100644 index 94170f1d7..000000000 --- a/Doc/source/colorLib/builder.rst +++ /dev/null @@ -1,8 +0,0 @@ -####### -builder -####### - -.. automodule:: fontTools.colorLib.builder - :inherited-members: - :members: - :undoc-members: diff --git a/Doc/source/colorLib/errors.rst b/Doc/source/colorLib/errors.rst deleted file mode 100644 index c06224b23..000000000 --- a/Doc/source/colorLib/errors.rst +++ /dev/null @@ -1,8 +0,0 @@ -###### -errors -###### - -.. automodule:: fontTools.colorLib.errors - :inherited-members: - :members: - :undoc-members: diff --git a/Doc/source/colorLib/index.rst b/Doc/source/colorLib/index.rst index 06721beac..d4eb9f83d 100644 --- 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: \ No newline at end of file + :undoc-members: diff --git a/Lib/fontTools/colorLib/builder.py b/Lib/fontTools/colorLib/builder.py index 9fe7f203b..dae00b918 100644 --- 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