improving sphinx documentation

docs/_themes/drawBotTheme/layout.html

@@ -128,6 +128,9 @@ <h2>Tweets</h2>
   </div>
   {% endblock %}
 
+
+
+
   {%- block relbar2 %}
   {% endblock %}
 

docs/_themes/drawBotTheme/static/drawBot.css_t

@@ -129,15 +129,15 @@ ul ul, ul ol, ol ol, ol ul {
 
 /* auto doc classes */
 
-.function dt {
+.function dt, .class dt {
 	font-size: 1.5em;
 	margin-bottom: 10px;
 	font-family: {{ theme_headerfont }};
 	font-weight: bold;
 	color: lightgray;
 }
 
-.function dt .descname {
+.function dt .descname, .class dt .descname {
 	color: #F7B805;
 }
 
@@ -230,6 +230,10 @@ div.navbar li a:hover {
 	font-weight: normal;
 }
 
+div.sphinxsidebarwrapper {
+	white-space: nowrap;
+}
+
 form {
 	display: block;
 }

docs/conf.py

@@ -52,28 +52,27 @@ def __getattr__(cls, name):
 
 MOCK_MODULES = ['py2app',
         'AppKit', 'Quartz', 'CoreText', 'QTKit',
-        'fontTools',
-        'fontTools.ttLib',
-        'fontTools.ttLib.ttCollection',
-        'fontTools.misc',
-        'fontTools.misc.transform',
-        'fontTools.misc.xmlWriter',
-        'fontTools.misc.py23',
-        'fontTools.misc.macCreatorType',
-        'fontTools.misc.macRes',
-        'fontTools.pens',
-        'fontTools.pens.basePen',
-        'fontTools.pens.areaPen',
-        'ufoLib',
-        'ufoLib.pointPen',
+        # 'fontTools',
+        # 'fontTools.ttLib',
+        # 'fontTools.ttLib.ttCollection',
+        # 'fontTools.misc',
+        # 'fontTools.misc.transform',
+        # 'fontTools.misc.xmlWriter',
+        # 'fontTools.misc.py23',
+        # 'fontTools.misc.macCreatorType',
+        # 'fontTools.misc.macRes',
+        # 'fontTools.pens',
+        # 'fontTools.pens.basePen',
+        # 'fontTools.pens.areaPen',
+        # 'fontTools.pens.pointPen',
         'booleanOperations',
         'vanilla',
         'vanilla.vanillaBase']
 
 for mod_name in MOCK_MODULES:
     sys.modules[mod_name] = Mock()
 
-print(sys.version_info)
+print("python version:", sys.version_info)
 
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
@@ -119,6 +118,8 @@ def __getattr__(cls, name):
 # The full version, including alpha/beta/rc tags.
 release = version
 
+autodoc_typehints = "none"
+
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
 #language = None

docs/content/drawBotIcon.rst

@@ -5,7 +5,7 @@ The making of (by Andy Clymer)
 
 .. downloadcode:: drawBotIcon.py
 
-    from ufoLib.glifLib import readGlyphFromString
+    from fontTools.ufoLib.glifLib import readGlyphFromString
     from fontTools.pens.cocoaPen import CocoaPen
     from fontParts.fontshell.glyph import RGlyph
     import random

docs/content/image/imageObject.rst

@@ -1,4 +1,5 @@
-ImageObject
-===========
+Image Objects
+=============
 
-.. autofunction::  drawBot.ImageObject
+.. autoclass::  drawBot.ImageObject
+    :members:

docs/content/shapes/bezierPath.rst

@@ -1,4 +1,9 @@
-BezierPath
-==========
+Bezier Paths
+============
 
-.. autofunction:: drawBot.BezierPath
+.. autoclass:: drawBot.BezierPath
+    :members:
+    :undoc-members:
+    :inherited-members:
+    :show-inheritance:
+    :exclude-members: copyContextProperties

docs/content/text/formattedString.rst

@@ -1,4 +1,9 @@
 Formatted Strings
 =================
 
-.. autofunction:: drawBot.FormattedString(txt=None, font=None, fontSize=10, fallbackFont=None, fill=(0, 0, 0), cmykFill=None, stroke=None, cmykStroke=None, strokeWidth=1, align=None, lineHeight=None, tracking=None, baselineShift=None, openTypeFeatures=None, tabs=None, language=None, indent=None, tailIndent=None, firstLineIndent=None, paragraphTopSpacing=None, paragraphBottomSpacing=None)
+.. autoclass:: drawBot.FormattedString(txt=None, font=None, fontSize=10, fallbackFont=None, fill=(0, 0, 0), cmykFill=None, stroke=None, cmykStroke=None, strokeWidth=1, align=None, lineHeight=None, tracking=None, baselineShift=None, openTypeFeatures=None, tabs=None, language=None, indent=None, tailIndent=None, firstLineIndent=None, paragraphTopSpacing=None, paragraphBottomSpacing=None)
+    :members:
+    :undoc-members:
+    :inherited-members:
+    :show-inheritance:
+    :exclude-members: copyContextProperties

drawBot/context/baseContext.py

@@ -205,14 +205,6 @@ class BezierPath(BasePen, SVGContextPropertyMixin, ContextPropertyMixin):
         # draw the path again
         drawPath(path)
 
-
-    .. autoclass:: drawBot.BezierPath
-        :members:
-        :undoc-members:
-        :inherited-members:
-        :show-inheritance:
-        :exclude-members: copyContextProperties
-
     """
 
     contourClass = BezierContour
@@ -1156,13 +1148,6 @@ class FormattedString(SVGContextPropertyMixin, ContextPropertyMixin):
 
         text(txt, (10, 150))
 
-    .. autoclass:: drawBot.FormattedString
-        :members:
-        :undoc-members:
-        :inherited-members:
-        :show-inheritance:
-        :exclude-members: copyContextProperties
-
     """
 
     _colorClass = Color
@@ -1649,7 +1634,7 @@ def fontSize(self, fontSize: float):
         """
         self._fontSize = fontSize
 
-    def fill(self, 
+    def fill(self,
             r: float | None = None,
             g: float | None = None,
             b: float | None = None,
@@ -1666,7 +1651,7 @@ def fill(self,
         self._fill = fill
         self._cmykFill = None
 
-    def stroke(self, 
+    def stroke(self,
               r: float | None = None,
               g: float | None = None,
               b: float | None = None,