[Bf-blender-cvs] SVN commit: /data/svn/bf-blender [28811] trunk/blender/source: include game engine docs in sphinx doc generation:

[Campbell Barton]

Revision: 28811
          http://projects.blender.org/plugins/scmsvn/viewcvs.php?view=rev&root=bf-blender&revision=28811
Author:   campbellbarton
Date:     2010-05-17 22:38:54 +0200 (Mon, 17 May 2010)

Log Message:
-----------
include game engine docs in sphinx doc generation:
 bge.events, logic, render & types (others still need work)

Updated http://www.blender.org/documentation/250PythonDoc

Modified Paths:
--------------
    trunk/blender/source/blender/python/doc/sphinx_doc_gen.py
    trunk/blender/source/gameengine/PyDoc/bge.events.rst
    trunk/blender/source/gameengine/PyDoc/bge.logic.rst
    trunk/blender/source/gameengine/PyDoc/bge.render.rst
    trunk/blender/source/gameengine/PyDoc/bge.types.rst

Modified: trunk/blender/source/blender/python/doc/sphinx_doc_gen.py
===================================================================
--- trunk/blender/source/blender/python/doc/sphinx_doc_gen.py	2010-05-17 19:52:25 UTC (rev 28810)
+++ trunk/blender/source/blender/python/doc/sphinx_doc_gen.py	2010-05-17 20:38:54 UTC (rev 28811)
@@ -324,6 +324,11 @@
     fw("      * user interface functions for defining buttons, creation of menus, headers, panels\n")
     fw("      * modules: bgl, mathutils and geometry\n")
     fw("\n")
+
+    fw("===================\n")
+    fw("Application Modules\n")
+    fw("===================\n")
+    fw("\n")
     fw(".. toctree::\n")
     fw("   :maxdepth: 1\n\n")
     fw("   bpy.ops.rst\n\n")
@@ -335,9 +340,30 @@
     
     # C modules
     fw("   bpy.props.rst\n\n")
-    
+
+    fw("==================\n")
+    fw("Standalone Modules\n")
+    fw("==================\n")
+    fw("\n")
+    fw(".. toctree::\n")
+    fw("   :maxdepth: 1\n\n")
+
+
     fw("   mathutils.rst\n\n")
     fw("   blf.rst\n\n")
+    
+    # game engine
+    fw("===================\n")
+    fw("Game Engine Modules\n")
+    fw("===================\n")
+    fw("\n")
+    fw(".. toctree::\n")
+    fw("   :maxdepth: 1\n\n")
+    fw("   bge.types.rst\n\n")
+    fw("   bge.logic.rst\n\n")
+    fw("   bge.render.rst\n\n")
+    fw("   bge.events.rst\n\n")
+
     file.close()
 
 
@@ -363,7 +389,6 @@
     file.close()
 
 
-
     # python modules
     from bpy import utils as module
     pymodule2sphinx(BASEPATH, "bpy.utils", module, "Utilities (bpy.utils)")
@@ -383,6 +408,15 @@
     pymodule2sphinx(BASEPATH, "blf", module, "Blender Font Drawing (blf)")
     del module
 
+    # game engine
+    import shutil
+    # copy2 keeps time/date stamps
+    shutil.copy2(os.path.join(BASEPATH, "../../../../gameengine/PyDoc/bge.types.rst"), BASEPATH)
+    shutil.copy2(os.path.join(BASEPATH, "../../../../gameengine/PyDoc/bge.logic.rst"), BASEPATH)
+    shutil.copy2(os.path.join(BASEPATH, "../../../../gameengine/PyDoc/bge.render.rst"), BASEPATH)
+    shutil.copy2(os.path.join(BASEPATH, "../../../../gameengine/PyDoc/bge.events.rst"), BASEPATH)
+
+
     if 0:
         filepath = os.path.join(BASEPATH, "bpy.rst")
         file = open(filepath, "w")

Modified: trunk/blender/source/gameengine/PyDoc/bge.events.rst
===================================================================
--- trunk/blender/source/gameengine/PyDoc/bge.events.rst	2010-05-17 19:52:25 UTC (rev 28810)
+++ trunk/blender/source/gameengine/PyDoc/bge.events.rst	2010-05-17 20:38:54 UTC (rev 28811)
@@ -1,6 +1,6 @@
 
-Documentation for the bge.events module.
-========================================
+Game Engine bge.events module.
+==============================
 
 This module holds key constants for the SCA_KeyboardSensor.
 

Modified: trunk/blender/source/gameengine/PyDoc/bge.logic.rst
===================================================================
--- trunk/blender/source/gameengine/PyDoc/bge.logic.rst	2010-05-17 19:52:25 UTC (rev 28810)
+++ trunk/blender/source/gameengine/PyDoc/bge.logic.rst	2010-05-17 20:38:54 UTC (rev 28811)
@@ -1,6 +1,6 @@
 
-Documentation for the bge.logic Module.
-=======================================
+Game Engine bge.logic Module.
+=============================
 	
 Module to access logic functions, imported automatically into the python controllers namespace.
 

Modified: trunk/blender/source/gameengine/PyDoc/bge.render.rst
===================================================================
--- trunk/blender/source/gameengine/PyDoc/bge.render.rst	2010-05-17 19:52:25 UTC (rev 28810)
+++ trunk/blender/source/gameengine/PyDoc/bge.render.rst	2010-05-17 20:38:54 UTC (rev 28811)
@@ -1,6 +1,6 @@
 
-Documentation for the bge.render Module.
-========================================
+Game Engine bge.render Module.
+==============================
 
 .. module:: bge.render
 

Modified: trunk/blender/source/gameengine/PyDoc/bge.types.rst
===================================================================
--- trunk/blender/source/gameengine/PyDoc/bge.types.rst	2010-05-17 19:52:25 UTC (rev 28810)
+++ trunk/blender/source/gameengine/PyDoc/bge.types.rst	2010-05-17 20:38:54 UTC (rev 28811)
@@ -1,6 +1,6 @@
 
-Documentation for the bge.types Module.
-=======================================
+Game Engine  bge.types Module.
+==============================
 
 .. module:: bge.types