Fix up automatic profile documentation

fonttools · Feb 22, 2024 · 4d775a7 · 4d775a7
1 parent 626947b
commit 4d775a7
Show file tree

Hide file tree

Showing 30 changed files with 100 additions and 868 deletions.
diff --git a/Lib/fontbakery/sphinx_extensions/profile.py b/Lib/fontbakery/sphinx_extensions/profile.py
diff --git a/docs/source/fontbakery/profiles/adobefonts.rst b/docs/source/fontbakery/profiles/adobefonts.rst
@@ -1,9 +1,5 @@
-##########
-adobefonts
-##########
+###########
+Adobe Fonts
+###########
 
-All vendor-specific profiles such as the `adobefonts` one also include the checks from the :doc:`universal` profile.
-
-.. automodule:: fontbakery.profiles.adobefonts
-   :members:
-   :undoc-members:
+.. autoprofile:: fontbakery.profiles.adobefonts
diff --git a/docs/source/fontbakery/profiles/cff.rst b/docs/source/fontbakery/profiles/cff.rst
diff --git a/docs/source/fontbakery/profiles/cmap.rst b/docs/source/fontbakery/profiles/cmap.rst
diff --git a/docs/source/fontbakery/profiles/dsig.rst b/docs/source/fontbakery/profiles/dsig.rst
diff --git a/docs/source/fontbakery/profiles/fontbureau.rst b/docs/source/fontbakery/profiles/fontbureau.rst
@@ -1,9 +1,5 @@
-##########
-fontbureau
-##########
+###########
+Font Bureau
+###########
 
-All vendor-specific profiles such as the `fontbureau` one also include the checks from the :doc:`universal` profile.
-
-.. automodule:: fontbakery.profiles.fontbureau
-   :members:
-   :undoc-members:
+.. autoprofile:: fontbakery.profiles.fontbureau
diff --git a/docs/source/fontbakery/profiles/fontval.rst b/docs/source/fontbakery/profiles/fontval.rst
@@ -1,7 +1,5 @@
-#######
-fontval
-#######
+########################
+Microsoft Font Validator
+########################
 
-.. automodule:: fontbakery.profiles.fontval
-   :members:
-   :undoc-members:
+.. autoprofile:: fontbakery.profiles.fontval
diff --git a/docs/source/fontbakery/profiles/fontwerk.rst b/docs/source/fontbakery/profiles/fontwerk.rst
@@ -1,12 +1,5 @@
 ########
-fontwerk
+Fontwerk
 ########
 
-All vendor-specific profiles such as the `fontwerk` one also include the checks from the :doc:`universal` profile. Fontwerk also includes most checks from the :doc:`googlefonts` profile, except these:
-
-.. literalinclude:: ../../../../Lib/fontbakery/profiles/fontwerk.py
-   :pyobject: leave_this_one_out
-
-.. automodule:: fontbakery.profiles.fontwerk
-   :members:
-   :undoc-members:
+.. autoprofile:: fontbakery.profiles.fontwerk
diff --git a/docs/source/fontbakery/profiles/fvar.rst b/docs/source/fontbakery/profiles/fvar.rst
diff --git a/docs/source/fontbakery/profiles/gdef.rst b/docs/source/fontbakery/profiles/gdef.rst
diff --git a/docs/source/fontbakery/profiles/glyf.rst b/docs/source/fontbakery/profiles/glyf.rst
diff --git a/docs/source/fontbakery/profiles/googlefonts.rst b/docs/source/fontbakery/profiles/googlefonts.rst
@@ -1,9 +1,5 @@
-###########
-googlefonts
-###########
+############
+Google Fonts
+############
 
-All vendor-specific profiles such as the `googlefonts` one also include the checks from the :doc:`universal` profile.
-
-.. automodule:: fontbakery.profiles.googlefonts
-   :members:
-   :undoc-members:
+.. autoprofile:: fontbakery.profiles.googlefonts
diff --git a/docs/source/fontbakery/profiles/googlefonts_conditions.rst b/docs/source/fontbakery/profiles/googlefonts_conditions.rst
diff --git a/docs/source/fontbakery/profiles/gpos.rst b/docs/source/fontbakery/profiles/gpos.rst
diff --git a/docs/source/fontbakery/profiles/head.rst b/docs/source/fontbakery/profiles/head.rst
diff --git a/docs/source/fontbakery/profiles/hhea.rst b/docs/source/fontbakery/profiles/hhea.rst
diff --git a/docs/source/fontbakery/profiles/index.rst b/docs/source/fontbakery/profiles/index.rst
@@ -15,13 +15,5 @@ profiles
    fontval
    ufo_sources
    iso15008
-   layout
    outline
    shaping
-   shared_conditions
-   googlefonts_conditions
-
-
-.. automodule:: fontbakery.profiles
-   :members:
-   :undoc-members:
diff --git a/docs/source/fontbakery/profiles/iso15008.rst b/docs/source/fontbakery/profiles/iso15008.rst
@@ -1,7 +1,5 @@
 ########
-iso15008
+ISO15008
 ########
 
-.. automodule:: fontbakery.profiles.iso15008
-   :members:
-   :undoc-members:
+.. autoprofile:: fontbakery.profiles.iso15008
diff --git a/docs/source/fontbakery/profiles/kern.rst b/docs/source/fontbakery/profiles/kern.rst
diff --git a/docs/source/fontbakery/profiles/layout.rst b/docs/source/fontbakery/profiles/layout.rst
diff --git a/docs/source/fontbakery/profiles/loca.rst b/docs/source/fontbakery/profiles/loca.rst
diff --git a/docs/source/fontbakery/profiles/name.rst b/docs/source/fontbakery/profiles/name.rst
diff --git a/docs/source/fontbakery/profiles/notofonts.rst b/docs/source/fontbakery/profiles/notofonts.rst
@@ -1,9 +1,5 @@
-#########
-notofonts
-#########
+##########
+Noto Fonts
+##########
 
-All vendor-specific profiles such as the `notofonts` one also include the checks from the :doc:`universal` profile.
-
-.. automodule:: fontbakery.profiles.notofonts
-   :members:
-   :undoc-members:
+.. autoprofile:: fontbakery.profiles.notofonts
diff --git a/docs/source/fontbakery/profiles/opentype.rst b/docs/source/fontbakery/profiles/opentype.rst
@@ -1,30 +1,6 @@
 ########
-opentype
+Opentype
 ########
 
-The checks of the `opentype` profile are separated in one sub-profile for each of the Open Type tables as listed below:
-
-.. toctree::
-   :maxdepth: 1
-
-   cff
-   cmap
-   dsig
-   fvar
-   gdef
-   glyf
-   gpos
-   head
-   hhea
-   kern
-   loca
-   name
-   os2
-   post
-   layout
-
-.. automodule:: fontbakery.profiles.opentype
-   :members:
-   :undoc-members:
-
- .. automodule:: fontbakery.profiles
+.. autoprofile:: fontbakery.profiles.opentype
+
diff --git a/docs/source/fontbakery/profiles/os2.rst b/docs/source/fontbakery/profiles/os2.rst
diff --git a/docs/source/fontbakery/profiles/outline.rst b/docs/source/fontbakery/profiles/outline.rst
@@ -1,7 +1,5 @@
 #######
-outline
+Outline
 #######
 
-.. automodule:: fontbakery.profiles.outline
-   :members:
-   :undoc-members:
+.. autoprofile:: fontbakery.profiles.outline
diff --git a/docs/source/fontbakery/profiles/post.rst b/docs/source/fontbakery/profiles/post.rst
diff --git a/docs/source/fontbakery/profiles/shaping.rst b/docs/source/fontbakery/profiles/shaping.rst
@@ -1,7 +1,5 @@
 #######
-shaping
+Shaping
 #######
 
-.. automodule:: fontbakery.profiles.shaping
-   :members:
-   :undoc-members:
+.. autoprofile:: fontbakery.profiles.shaping
diff --git a/docs/source/fontbakery/profiles/shared_conditions.rst b/docs/source/fontbakery/profiles/shared_conditions.rst
diff --git a/docs/source/fontbakery/profiles/ufo_sources.rst b/docs/source/fontbakery/profiles/ufo_sources.rst
@@ -1,7 +1,5 @@
 ###########
-ufo_sources
+UFO Sources
 ###########
 
-.. automodule:: fontbakery.profiles.ufo_sources
-   :members:
-   :undoc-members:
+.. autoprofile:: fontbakery.profiles.ufo_sources