From dcb6f226930282172f8ac937cc72931b76937e7e Mon Sep 17 00:00:00 2001 From: Nathan Williis Date: Thu, 5 Dec 2024 16:07:38 +0000 Subject: [PATCH] Docs, add crossreferences to bitmap-table-helper-module docs rather than duplicating automodule directives. --- Doc/source/ttLib/tables/Bitmap_related.rst | 6 +++--- Doc/source/ttLib/tables/C_B_D_T_.rst | 4 ++++ Doc/source/ttLib/tables/C_B_L_C_.rst | 4 ++++ Doc/source/ttLib/tables/E_B_D_T_.rst | 13 ++++--------- Doc/source/ttLib/tables/E_B_L_C_.rst | 14 ++++---------- Doc/source/ttLib/tables/_s_b_i_x.rst | 20 ++++---------------- 6 files changed, 23 insertions(+), 38 deletions(-) diff --git a/Doc/source/ttLib/tables/Bitmap_related.rst b/Doc/source/ttLib/tables/Bitmap_related.rst index 1372d1950..01bf0d009 100644 --- a/Doc/source/ttLib/tables/Bitmap_related.rst +++ b/Doc/source/ttLib/tables/Bitmap_related.rst @@ -8,10 +8,10 @@ Bitmap-data helper modules .. rubric:: Overview: :heading-level: 2 -The :mod:`fontTools.ttLib.ttCollection` module is a helper for -:mod:`fontTools.ttLib` that implements lower-level support for various +The modules documented on this page are helpers for +:mod:`fontTools.ttLib` that implement lower-level support for various table converters that need to interact with bitmapped data. The -:mod:`.BitmapGlyphmetrics` module is used for the ``EBDT``/``EBLC`` and +:mod:`.BitmapGlyphMetrics` module is used for the ``EBDT``/``EBLC`` and ``CBDT``/``CBLC`` tables, and :mod:`.sbixGlyph` and :mod:`.sbixStrike` are used for the ``sbix`` table. diff --git a/Doc/source/ttLib/tables/C_B_D_T_.rst b/Doc/source/ttLib/tables/C_B_D_T_.rst index a6882064c..3a06fa132 100644 --- a/Doc/source/ttLib/tables/C_B_D_T_.rst +++ b/Doc/source/ttLib/tables/C_B_D_T_.rst @@ -3,6 +3,10 @@ The ``CBDT`` table is an OpenType table. +This ``CBDT`` table converter module depends on the +:mod:`.BitmapGlyphMetrics` module, which it shares with the ``EBDT``, +``EBLC``, and ``CBLC`` converters. + .. automodule:: fontTools.ttLib.tables.C_B_D_T_ :members: :undoc-members: diff --git a/Doc/source/ttLib/tables/C_B_L_C_.rst b/Doc/source/ttLib/tables/C_B_L_C_.rst index 0aa134239..aec847e69 100644 --- a/Doc/source/ttLib/tables/C_B_L_C_.rst +++ b/Doc/source/ttLib/tables/C_B_L_C_.rst @@ -3,6 +3,10 @@ The ``CBLC`` table is an OpenType table. +This ``CBLC`` table converter module depends on the +:mod:`.BitmapGlyphMetrics` module, which it shares with the ``EBDT``, +``EBLC``, and ``CBDT`` converters. + .. automodule:: fontTools.ttLib.tables.C_B_L_C_ :members: :undoc-members: diff --git a/Doc/source/ttLib/tables/E_B_D_T_.rst b/Doc/source/ttLib/tables/E_B_D_T_.rst index ebb673484..bc1bd5bdb 100644 --- a/Doc/source/ttLib/tables/E_B_D_T_.rst +++ b/Doc/source/ttLib/tables/E_B_D_T_.rst @@ -3,16 +3,11 @@ The ``EBDT`` table is an OpenType table. +This ``EBDT`` table converter module depends on the +:mod:`.BitmapGlyphMetrics` module, which it shares with the ``EBLC``, +``CBDT``, and ``CBLC`` converters. + .. automodule:: fontTools.ttLib.tables.E_B_D_T_ :members: :undoc-members: - -BitmapGlyphMetrics -^^^^^^^^^^^^^^^^^^ - -.. automodule:: fontTools.ttLib.tables.BitmapGlyphMetrics - :noindex: - :members: - :undoc-members: - diff --git a/Doc/source/ttLib/tables/E_B_L_C_.rst b/Doc/source/ttLib/tables/E_B_L_C_.rst index a101db543..e9529b07c 100644 --- a/Doc/source/ttLib/tables/E_B_L_C_.rst +++ b/Doc/source/ttLib/tables/E_B_L_C_.rst @@ -3,16 +3,10 @@ The ``EBLC`` table is an OpenType table. +This ``EBLC`` table converter module depends on the +:mod:`.BitmapGlyphMetrics` module, which it shares with the ``EBDT``, +``CBDT``, and ``CBLC`` converters. + .. automodule:: fontTools.ttLib.tables.E_B_L_C_ :members: :undoc-members: - - -BitmapGlyphMetrics -^^^^^^^^^^^^^^^^^^ - -.. automodule:: fontTools.ttLib.tables.BitmapGlyphMetrics - :noindex: - :members: - :undoc-members: - diff --git a/Doc/source/ttLib/tables/_s_b_i_x.rst b/Doc/source/ttLib/tables/_s_b_i_x.rst index 926e6eeb6..927dfe7d8 100644 --- a/Doc/source/ttLib/tables/_s_b_i_x.rst +++ b/Doc/source/ttLib/tables/_s_b_i_x.rst @@ -3,22 +3,10 @@ The ``sbix`` table is an OpenType table. +This ``sbix`` table converter module depends on the +:mod:`.sbixGlyph` and :mod:`.sbixStrike` modules. + + .. automodule:: fontTools.ttLib.tables._s_b_i_x :members: :undoc-members: - - - -sbixGlyph -^^^^^^^^^ - -.. automodule:: fontTools.ttLib.tables.sbixGlyph - :members: - :undoc-members: - -sbixStrike -^^^^^^^^^^ - -.. automodule:: fontTools.ttLib.tables.sbixStrike - :members: - :undoc-members: