Early, early work on Sphinx documentation.

robotools · Mar 25, 2016 · 1afd100 · 1afd100
1 parent 3c6c30e
commit 1afd100
Show file tree

Hide file tree

Showing 22 changed files with 1,231 additions and 17 deletions.
diff --git a/.gitignore b/.gitignore
@@ -5,3 +5,5 @@
 *.pyc
 build/*
 dist/*
+
+documentation/build/*
diff --git a/Lib/fontParts/objects/base/font.py b/Lib/fontParts/objects/base/font.py
@@ -154,21 +154,36 @@ def generate(self, format, path=None):
         """
         Generate the font to another format.
 
-        format defines the file format to output. These are the standard
-
-        mactype1     = Mac Type 1 font (generates suitcase  and LWFN file)
-        macttf       = Mac TrueType font (generates suitcase)
-        macttdfont   = Mac TrueType font (generates suitcase with resources in data fork)
-        otfcff       = PS OpenType (CFF-based) font (OTF)
-        otfttf       = PC TrueType/TT OpenType font (TTF)
-        pctype1      = PC Type 1 font (binary/PFB)
-        pcmm         = PC MultipleMaster font (PFB)
-        pctype1ascii = PC Type 1 font (ASCII/PFA)
-        pcmmascii    = PC MultipleMaster font (ASCII/PFA)
-        ufo1         = UFO format version 1
-        ufo2         = UFO format version 2
-        ufo3         = UFO format version 3
-        unixascii    = UNIX ASCII font (ASCII/PFA)
+        format defines the file format to output. These are the
+        standard format identifiers.
+
+        +--------------+--------------------------------------------------------------------+
+        | mactype1     | Mac Type 1 font (generates suitcase  and LWFN file)                |
+        +--------------+--------------------------------------------------------------------+
+        | macttf       | Mac TrueType font (generates suitcase)                             |
+        +--------------+--------------------------------------------------------------------+
+        | macttdfont   | Mac TrueType font (generates suitcase with resources in data fork) |
+        +--------------+--------------------------------------------------------------------+
+        | otfcff       | PS OpenType (CFF-based) font (OTF)                                 |
+        +--------------+--------------------------------------------------------------------+
+        | otfttf       | PC TrueType/TT OpenType font (TTF)                                 |
+        +--------------+--------------------------------------------------------------------+
+        | pctype1      | PC Type 1 font (binary/PFB)                                        |
+        +--------------+--------------------------------------------------------------------+
+        | pcmm         | PC MultipleMaster font (PFB)                                       |
+        +--------------+--------------------------------------------------------------------+
+        | pctype1ascii | PC Type 1 font (ASCII/PFA)                                         |
+        +--------------+--------------------------------------------------------------------+
+        | pcmmascii    | PC MultipleMaster font (ASCII/PFA)                                 |
+        +--------------+--------------------------------------------------------------------+
+        | ufo1         | UFO format version 1                                               |
+        +--------------+--------------------------------------------------------------------+
+        | ufo2         | UFO format version 2                                               |
+        +--------------+--------------------------------------------------------------------+
+        | ufo3         | UFO format version 3                                               |
+        +--------------+--------------------------------------------------------------------+
+        | unixascii    | UNIX ASCII font (ASCII/PFA)                                        |
+        +--------------+--------------------------------------------------------------------+
 
         Environments are not required to support all of these.
         Environments may define their own format types.
@@ -361,8 +376,6 @@ def _setFontInLayer(self, layer):
         if layer.font is None:
             layer.font = self
 
-    defaultLayer = dynamicProperty("base_defaultLayer", "The name of the font's default layer.")
-
     def _get_base_defaultLayer(self):
         value = self._get_defaultLayer()
         value = validators.validateDefaultLayer(value, self)
@@ -388,6 +401,8 @@ def _set_defaultLayer(self, value, **kwargs):
         """
         self.raiseNotImplementedError()
 
+    defaultLayer = dynamicProperty("base_defaultLayer", "The name of the font's default layer.")
+
     # get
 
     def getLayer(self, name):