diff options
author | Campbell Barton <ideasman42@gmail.com> | 2010-05-18 00:38:54 +0400 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2010-05-18 00:38:54 +0400 |
commit | 45444ceee308bdbc40078975b48e4ce743253d24 (patch) | |
tree | d95a9b68148c2d7faee671598da3be8e599ce3b8 /source | |
parent | 3a12668e922bfd8deecde5578b776e87b6d5cc24 (diff) |
include game engine docs in sphinx doc generation:
bge.events, logic, render & types (others still need work)
Updated http://www.blender.org/documentation/250PythonDoc
Diffstat (limited to 'source')
-rw-r--r-- | source/blender/python/doc/sphinx_doc_gen.py | 38 | ||||
-rw-r--r-- | source/gameengine/PyDoc/bge.events.rst | 4 | ||||
-rw-r--r-- | source/gameengine/PyDoc/bge.logic.rst | 4 | ||||
-rw-r--r-- | source/gameengine/PyDoc/bge.render.rst | 4 | ||||
-rw-r--r-- | source/gameengine/PyDoc/bge.types.rst | 4 |
5 files changed, 44 insertions, 10 deletions
diff --git a/source/blender/python/doc/sphinx_doc_gen.py b/source/blender/python/doc/sphinx_doc_gen.py index 407bc752d58..aa42c2f8a4a 100644 --- a/source/blender/python/doc/sphinx_doc_gen.py +++ b/source/blender/python/doc/sphinx_doc_gen.py @@ -324,6 +324,11 @@ def rna2sphinx(BASEPATH): 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 @@ def rna2sphinx(BASEPATH): # 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 @@ def rna2sphinx(BASEPATH): file.close() - # python modules from bpy import utils as module pymodule2sphinx(BASEPATH, "bpy.utils", module, "Utilities (bpy.utils)") @@ -383,6 +408,15 @@ def rna2sphinx(BASEPATH): 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") diff --git a/source/gameengine/PyDoc/bge.events.rst b/source/gameengine/PyDoc/bge.events.rst index 60f9c81f169..afdcf39f178 100644 --- a/source/gameengine/PyDoc/bge.events.rst +++ b/source/gameengine/PyDoc/bge.events.rst @@ -1,6 +1,6 @@ -Documentation for the bge.events module. -======================================== +Game Engine bge.events module. +============================== This module holds key constants for the SCA_KeyboardSensor. diff --git a/source/gameengine/PyDoc/bge.logic.rst b/source/gameengine/PyDoc/bge.logic.rst index 2d08ae15d6d..7fb2c3df67a 100644 --- a/source/gameengine/PyDoc/bge.logic.rst +++ b/source/gameengine/PyDoc/bge.logic.rst @@ -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. diff --git a/source/gameengine/PyDoc/bge.render.rst b/source/gameengine/PyDoc/bge.render.rst index be89aa8e8f7..d1a35019165 100644 --- a/source/gameengine/PyDoc/bge.render.rst +++ b/source/gameengine/PyDoc/bge.render.rst @@ -1,6 +1,6 @@ -Documentation for the bge.render Module. -======================================== +Game Engine bge.render Module. +============================== .. module:: bge.render diff --git a/source/gameengine/PyDoc/bge.types.rst b/source/gameengine/PyDoc/bge.types.rst index f71a9818e02..6cfb3377cac 100644 --- a/source/gameengine/PyDoc/bge.types.rst +++ b/source/gameengine/PyDoc/bge.types.rst @@ -1,6 +1,6 @@ -Documentation for the bge.types Module. -======================================= +Game Engine bge.types Module. +============================== .. module:: bge.types |