[Bf-blender-cvs] SVN commit: /data/svn/bf-blender [40984] trunk/blender: py docs - gpu module wasn't included in docs.
Campbell Barton
ideasman42 at gmail.com
Thu Oct 13 08:59:10 CEST 2011
Revision: 40984
http://projects.blender.org/scm/viewvc.php?view=rev&root=bf-blender&revision=40984
Author: campbellbarton
Date: 2011-10-13 06:59:09 +0000 (Thu, 13 Oct 2011)
Log Message:
-----------
py docs - gpu module wasn't included in docs.
also added convenience target to build sphinx api docs:
make doc_py
Modified Paths:
--------------
trunk/blender/GNUmakefile
trunk/blender/doc/python_api/rst/gpu.rst
trunk/blender/doc/python_api/sphinx_doc_gen.py
Modified: trunk/blender/GNUmakefile
===================================================================
--- trunk/blender/GNUmakefile 2011-10-13 06:07:11 UTC (rev 40983)
+++ trunk/blender/GNUmakefile 2011-10-13 06:59:09 UTC (rev 40984)
@@ -145,6 +145,9 @@
@echo " * check_splint - run blenders source through splint (C only)"
@echo " * check_sparse - run blenders source through sparse (C only)"
@echo ""
+ @echo "Documentation Targets"
+ @echo " * doc_py - generate sphinx python api docs"
+ @echo ""
# -----------------------------------------------------------------------------
# Packages
@@ -222,6 +225,17 @@
cd $(BUILD_DIR) ; python3 $(BLENDER_DIR)/build_files/cmake/cmake_static_check_sparse.py
+# -----------------------------------------------------------------------------
+# Documentation
+#
+
+# Simple version of ./doc/python_api/sphinx_doc_gen.sh with no PDF generation.
+doc_py:
+ $(BUILD_DIR)/bin/blender --background --factory-startup --python doc/python_api/sphinx_doc_gen.py
+ cd doc/python_api ; sphinx-build -n -b html sphinx-in sphinx-out
+ @echo "docs written into: 'doc/python_api/sphinx-out/index.html'"
+
+
clean:
$(MAKE) -C $(BUILD_DIR) clean
Modified: trunk/blender/doc/python_api/rst/gpu.rst
===================================================================
--- trunk/blender/doc/python_api/rst/gpu.rst 2011-10-13 06:07:11 UTC (rev 40983)
+++ trunk/blender/doc/python_api/rst/gpu.rst 2011-10-13 06:59:09 UTC (rev 40984)
@@ -1,7 +1,10 @@
-
GPU functions (gpu)
===================
+.. module:: gpu
+
+This module provides access to materials GLSL shaders.
+
*****
Intro
*****
@@ -16,7 +19,6 @@
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
Modified: trunk/blender/doc/python_api/sphinx_doc_gen.py
===================================================================
--- trunk/blender/doc/python_api/sphinx_doc_gen.py 2011-10-13 06:07:11 UTC (rev 40983)
+++ trunk/blender/doc/python_api/sphinx_doc_gen.py 2011-10-13 06:59:09 UTC (rev 40984)
@@ -83,6 +83,7 @@
"aud",
"bgl",
"blf",
+ "gpu",
"mathutils",
"mathutils.geometry",
)
@@ -1122,6 +1123,8 @@
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 @@
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")
More information about the Bf-blender-cvs
mailing list