diff options
| author | Campbell Barton <ideasman42@gmail.com> | 2011-10-13 10:59:09 +0400 |
|---|---|---|
| committer | Campbell Barton <ideasman42@gmail.com> | 2011-10-13 10:59:09 +0400 |
| commit | c40b976ea87bcbab01a8f939d20996ba1a465772 (patch) | |
| tree | 5b7b30fbe96e89dd766593451ec98409f81718c4 /doc | |
| parent | 7360f64a5138ce633fda93fbe06d850daa649d57 (diff) | |
py docs - gpu module wasn't included in docs.
also added convenience target to build sphinx api docs:
make doc_py
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/python_api/rst/gpu.rst | 6 | ||||
| -rw-r--r-- | doc/python_api/sphinx_doc_gen.py | 10 |
2 files changed, 14 insertions, 2 deletions
diff --git a/doc/python_api/rst/gpu.rst b/doc/python_api/rst/gpu.rst index 72a5dc2f5d3..2ca7fdda9d5 100644 --- a/doc/python_api/rst/gpu.rst +++ b/doc/python_api/rst/gpu.rst @@ -1,7 +1,10 @@ - GPU functions (gpu) =================== +.. module:: gpu + +This module provides access to materials GLSL shaders. + ***** Intro ***** @@ -16,7 +19,6 @@ and in the game engine. are are closely related to Blender's internal GLSL code and may change if the GLSL code is modified (e.g. new uniform type). -.. module:: gpu ********* Constants diff --git a/doc/python_api/sphinx_doc_gen.py b/doc/python_api/sphinx_doc_gen.py index 8743a89057e..2ccf67e2db4 100644 --- a/doc/python_api/sphinx_doc_gen.py +++ b/doc/python_api/sphinx_doc_gen.py @@ -83,6 +83,7 @@ else: "aud", "bgl", "blf", + "gpu", "mathutils", "mathutils.geometry", ) @@ -1122,6 +1123,8 @@ def rna2sphinx(BASEPATH): fw(" bgl.rst\n\n") if "blf" not in EXCLUDE_MODULES: fw(" blf.rst\n\n") + if "gpu" not in EXCLUDE_MODULES: + fw(" gpu.rst\n\n") if "aud" not in EXCLUDE_MODULES: fw(" aud.rst\n\n") if "bpy_extras" not in EXCLUDE_MODULES: @@ -1262,6 +1265,13 @@ def rna2sphinx(BASEPATH): import shutil shutil.copy2(os.path.join(BASEPATH, "..", "rst", "bgl.rst"), BASEPATH) + if "gpu" not in EXCLUDE_MODULES: + #import gpu as module + #pymodule2sphinx(BASEPATH, "gpu", module, "GPU Shader Module") + #del module + import shutil + shutil.copy2(os.path.join(BASEPATH, "..", "rst", "gpu.rst"), BASEPATH) + if "aud" not in EXCLUDE_MODULES: import aud as module pymodule2sphinx(BASEPATH, "aud", module, "Audio System") |