From 6ec2b67152d205b98ca153b22def04b0ed266af9 Mon Sep 17 00:00:00 2001 From: Nathan Williis Date: Thu, 15 Aug 2024 11:32:05 +0100 Subject: [PATCH 1/5] Remove duplicate sidebar entries for ttLib.ttFont.TTFont and .GlyphOrder. --- Doc/source/ttLib/ttFont.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Doc/source/ttLib/ttFont.rst b/Doc/source/ttLib/ttFont.rst index a3b4c9d0e..d094b29dc 100644 --- a/Doc/source/ttLib/ttFont.rst +++ b/Doc/source/ttLib/ttFont.rst @@ -14,4 +14,4 @@ ttFont: Read/write OpenType and TrueType fonts .. automodule:: fontTools.ttLib.ttFont :members: getTableModule, registerCustomTableClass, unregisterCustomTableClass, getCustomTableClass, getClassTag, newTable, tagToIdentifier, identifierToTag, tagToXML, xmlToTag, sortedTagList, reorderFontTables - + :exclude-members: TTFont, GlyphOrder From 31b5ce1f8ec5c520d0c50894ebedb99fba50d27c Mon Sep 17 00:00:00 2001 From: Nathan Williis Date: Tue, 20 Aug 2024 16:12:00 +0100 Subject: [PATCH 2/5] Docs, minor: fix Sphinx warnings. --- Doc/source/colorLib/index.rst | 1 + Doc/source/designspaceLib/xml.rst | 2 +- Doc/source/developer.rst | 1 + Doc/source/index.rst | 2 +- 4 files changed, 4 insertions(+), 2 deletions(-) diff --git a/Doc/source/colorLib/index.rst b/Doc/source/colorLib/index.rst index 5a9bf8a16..f9447f622 100644 --- a/Doc/source/colorLib/index.rst +++ b/Doc/source/colorLib/index.rst @@ -3,3 +3,4 @@ colorLib.builder: Build COLR/CPAL tables from scratch ##################################################### .. automodule:: fontTools.colorLib.builder + :no-inherited-members: diff --git a/Doc/source/designspaceLib/xml.rst b/Doc/source/designspaceLib/xml.rst index 7b59dbb17..d8c76be99 100644 --- a/Doc/source/designspaceLib/xml.rst +++ b/Doc/source/designspaceLib/xml.rst @@ -297,7 +297,7 @@ Example of all axis elements together ```` element -................... +.................... - Defines the output location of an axis mapping. - Child element of ```` diff --git a/Doc/source/developer.rst b/Doc/source/developer.rst index e480706af..abaea79af 100644 --- a/Doc/source/developer.rst +++ b/Doc/source/developer.rst @@ -1,4 +1,5 @@ :orphan: + .. _developerinfo: .. image:: ../../Icons/FontToolsIconGreenCircle.png :width: 200px diff --git a/Doc/source/index.rst b/Doc/source/index.rst index 51dfc3c11..e74abf219 100644 --- a/Doc/source/index.rst +++ b/Doc/source/index.rst @@ -6,7 +6,7 @@ ---fontTools Documentation--- -======= +============================= About ----- From 6f7d949d5cd408e8dbcaaa703d783e0a07641395 Mon Sep 17 00:00:00 2001 From: Nathan Williis Date: Tue, 20 Aug 2024 16:14:46 +0100 Subject: [PATCH 3/5] Docs: update Sphinx config, to show inheritance. This should simplify cross-module readability, and also makes errors caused by autodoc easier to spot. --- Doc/source/conf.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Doc/source/conf.py b/Doc/source/conf.py index 982af8032..d07a34aca 100644 --- a/Doc/source/conf.py +++ b/Doc/source/conf.py @@ -40,7 +40,7 @@ extensions = [ autodoc_mock_imports = ["gtk", "reportlab"] -autodoc_default_options = {"members": True, "inherited-members": True} +autodoc_default_options = {"members": True, "inherited-members": True, "show-inheritance": True} # Add any paths that contain templates here, relative to this directory. templates_path = ["_templates"] @@ -78,7 +78,7 @@ release = "4.0" # # This is also used if you do content translation via gettext catalogs. # Usually you set "language" from the command line for these cases. -language = None +language = "en" # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. From 868f50daf4ca71a1bb9a63556b399985518c6410 Mon Sep 17 00:00:00 2001 From: Nathan Williis Date: Tue, 20 Aug 2024 16:15:50 +0100 Subject: [PATCH 4/5] Pin the Sphinx dependency to v7; v8 breaks the RTD theme. See issue #3606 --- Doc/docs-requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Doc/docs-requirements.txt b/Doc/docs-requirements.txt index c43b92471..4269223fb 100644 --- a/Doc/docs-requirements.txt +++ b/Doc/docs-requirements.txt @@ -1,4 +1,4 @@ -sphinx==8.0.2 +sphinx==7.4.3 sphinx_rtd_theme==2.0.0 reportlab==4.2.2 freetype-py==2.4.0 From 1781cf8f7503f27ebf122b173764a8dee0da5620 Mon Sep 17 00:00:00 2001 From: Nathan Williis Date: Tue, 20 Aug 2024 17:00:52 +0100 Subject: [PATCH 5/5] Docs, minor: reformat line for lint GH action. --- Doc/source/conf.py | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/Doc/source/conf.py b/Doc/source/conf.py index d07a34aca..cee66549b 100644 --- a/Doc/source/conf.py +++ b/Doc/source/conf.py @@ -40,7 +40,11 @@ extensions = [ autodoc_mock_imports = ["gtk", "reportlab"] -autodoc_default_options = {"members": True, "inherited-members": True, "show-inheritance": True} +autodoc_default_options = { + "members": True, + "inherited-members": True, + "show-inheritance": True, +} # Add any paths that contain templates here, relative to this directory. templates_path = ["_templates"]