[Bf-blender-cvs] SVN commit: /data/svn/bf-blender [56166] trunk/blender/doc/python_api: Py API doc generation: add bpy.app.translations module, and fix a few errors found while building the doc.

Bastien Montagne montagne29 at wanadoo.fr
Fri Apr 19 15:00:21 CEST 2013


Revision: 56166
          http://projects.blender.org/scm/viewvc.php?view=rev&root=bf-blender&revision=56166
Author:   mont29
Date:     2013-04-19 13:00:21 +0000 (Fri, 19 Apr 2013)
Log Message:
-----------
Py API doc generation: add bpy.app.translations module, and fix a few errors found while building the doc. Thanks to Campbell for review.

Modified Paths:
--------------
    trunk/blender/doc/python_api/rst_from_bmesh_opdefines.py
    trunk/blender/doc/python_api/sphinx_doc_gen.py
    trunk/blender/doc/python_api/sphinx_doc_gen.sh

Modified: trunk/blender/doc/python_api/rst_from_bmesh_opdefines.py
===================================================================
--- trunk/blender/doc/python_api/rst_from_bmesh_opdefines.py	2013-04-19 12:14:15 UTC (rev 56165)
+++ trunk/blender/doc/python_api/rst_from_bmesh_opdefines.py	2013-04-19 13:00:21 UTC (rev 56166)
@@ -142,7 +142,10 @@
         "BM_EDGE",
         "BM_FACE",
 
-        "BMO_OP_FLAG_UNTAN_MULTIRES",
+        "BMO_OPTYPE_FLAG_NORMALS_CALC",
+        "BMO_OPTYPE_FLAG_UNTAN_MULTIRES",
+        "BMO_OPTYPE_FLAG_SELECT_FLUSH",
+        "BMO_OPTYPE_FLAG_NOP",
     )
     vars_dict = {}
     for i, v in enumerate(vars):

Modified: trunk/blender/doc/python_api/sphinx_doc_gen.py
===================================================================
--- trunk/blender/doc/python_api/sphinx_doc_gen.py	2013-04-19 12:14:15 UTC (rev 56165)
+++ trunk/blender/doc/python_api/sphinx_doc_gen.py	2013-04-19 13:00:21 UTC (rev 56166)
@@ -250,6 +250,7 @@
         "bmesh.utils",
         "bpy.app",
         "bpy.app.handlers",
+        "bpy.app.translations",
         "bpy.context",
         "bpy.data",
         "bpy.ops",  # supports filtering
@@ -857,7 +858,7 @@
             classes.append((attribute, value))
         elif issubclass(value_type, types.ModuleType):
             submodules.append((attribute, value))
-        elif value_type in (bool, int, float, str, tuple):
+        elif issubclass(value_type, (bool, int, float, str, tuple)):
             # constant, not much fun we can do here except to list it.
             # TODO, figure out some way to document these!
             fw(".. data:: %s\n\n" % attribute)
@@ -1538,6 +1539,7 @@
         "bpy.path",
         "bpy.app",
         "bpy.app.handlers",
+        "bpy.app.translations",
 
         # C modules
         "bpy.props",
@@ -1687,23 +1689,24 @@
     '''
     importable_modules = {
         # python_modules
-        "bpy.path"          : "Path Utilities",
-        "bpy.utils"         : "Utilities",
-        "bpy_extras"        : "Extra Utilities",
+        "bpy.path"             : "Path Utilities",
+        "bpy.utils"            : "Utilities",
+        "bpy_extras"           : "Extra Utilities",
 
         # C_modules
-        "aud"               : "Audio System",
-        "blf"               : "Font Drawing",
-        "bmesh"             : "BMesh Module",
-        "bmesh.types"       : "BMesh Types",
-        "bmesh.utils"       : "BMesh Utilities",
-        "bpy.app"           : "Application Data",
-        "bpy.app.handlers"  : "Application Handlers",
-        "bpy.props"         : "Property Definitions",
-        "mathutils"         : "Math Types & Utilities",
-        "mathutils.geometry": "Geometry Utilities",
-        "mathutils.noise"   : "Noise Utilities",
-        "freestyle"         : "Freestyle Data Types & Operators",
+        "aud"                  : "Audio System",
+        "blf"                  : "Font Drawing",
+        "bmesh"                : "BMesh Module",
+        "bmesh.types"          : "BMesh Types",
+        "bmesh.utils"          : "BMesh Utilities",
+        "bpy.app"              : "Application Data",
+        "bpy.app.handlers"     : "Application Handlers",
+        "bpy.app.translations" : "Application Translations",
+        "bpy.props"            : "Property Definitions",
+        "mathutils"            : "Math Types & Utilities",
+        "mathutils.geometry"   : "Geometry Utilities",
+        "mathutils.noise"      : "Noise Utilities",
+        "freestyle"            : "Freestyle Data Types & Operators",
     }
     for mod_name, mod_descr in importable_modules.items():
         if mod_name not in EXCLUDE_MODULES:
@@ -1745,6 +1748,9 @@
         bge_types_dir = os.path.join(RST_DIR, "bge_types")
 
         for i in os.listdir(bge_types_dir):
+            if i.startswith("."):
+                # Avoid things like .svn dir...
+                continue
             shutil.copy2(os.path.join(bge_types_dir, i), basepath)
 
     # changelog

Modified: trunk/blender/doc/python_api/sphinx_doc_gen.sh
===================================================================
--- trunk/blender/doc/python_api/sphinx_doc_gen.sh	2013-04-19 12:14:15 UTC (rev 56165)
+++ trunk/blender/doc/python_api/sphinx_doc_gen.sh	2013-04-19 13:00:21 UTC (rev 56166)
@@ -1,6 +1,6 @@
 #!/bin/sh
 # run from the blender source dir
-#   bash source/blender/python/doc/sphinx_doc_gen.sh
+#   bash doc/python_api/sphinx_doc_gen.sh
 # ssh upload means you need an account on the server
 
 




More information about the Bf-blender-cvs mailing list