Welcome to mirror list, hosted at ThFree Co, Russian Federation.

git.blender.org/blender.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorCampbell Barton <ideasman42@gmail.com>2010-12-10 03:20:32 +0300
committerCampbell Barton <ideasman42@gmail.com>2010-12-10 03:20:32 +0300
commitb4081bfc7beecf45d58137885c6abac81e3fb27b (patch)
tree493d7521006bafbe90f8da21454c8d6440c3b199 /doc
parent2ed82275b5738255f3830b25c5a7375501246911 (diff)
patch [#25027] formatting mathutils.geometry module docs for sphinx
from Luka Bonavita See: http://www.blender.org/documentation/250PythonDoc/mathutils.geometry.html
Diffstat (limited to 'doc')
-rw-r--r--doc/python_api/sphinx_doc_gen.py25
1 files changed, 21 insertions, 4 deletions
diff --git a/doc/python_api/sphinx_doc_gen.py b/doc/python_api/sphinx_doc_gen.py
index 1353dcf70d7..ae0bb43d1bc 100644
--- a/doc/python_api/sphinx_doc_gen.py
+++ b/doc/python_api/sphinx_doc_gen.py
@@ -64,11 +64,16 @@ EXAMPLE_SET_USED = set()
_BPY_STRUCT_FAKE = "bpy_struct"
_BPY_FULL_REBUILD = False
+
def undocumented_message(module_name, type_name, identifier):
- message = "Undocumented (`contribute " \
- "<http://wiki.blender.org/index.php/Dev:2.5/Py/API/Documentation/Contribute" \
- "?action=edit&section=new&preload=Dev:2.5/Py/API/Documentation/Contribute/Howto-message" \
- "&preloadtitle=%s.%s.%s>`_)\n\n" % (module_name, type_name, identifier)
+ if str(type_name).startswith('<module'):
+ preloadtitle = '%s.%s' % (module_name, identifier)
+ else:
+ preloadtitle = '%s.%s.%s' % (module_name, type_name, identifier)
+ message = "Undocumented (`contribute "\
+ "<http://wiki.blender.org/index.php/Dev:2.5/Py/API/Documentation/Contribute"\
+ "?action=edit&section=new&preload=Dev:2.5/Py/API/Documentation/Contribute/Howto-message"\
+ "&preloadtitle=%s>`_)\n\n" % preloadtitle
return message
@@ -405,6 +410,9 @@ def rna2sphinx(BASEPATH):
fw(" mathutils.rst\n\n")
+ fw(" mathutils.geometry.rst\n\n")
+ # XXX TODO
+ #fw(" bgl.rst\n\n")
fw(" blf.rst\n\n")
fw(" aud.rst\n\n")
@@ -485,11 +493,20 @@ def rna2sphinx(BASEPATH):
import mathutils as module
pymodule2sphinx(BASEPATH, "mathutils", module, "Math Types & Utilities (mathutils)")
del module
+
+ import mathutils.geometry as module
+ pymodule2sphinx(BASEPATH, "mathutils.geometry", module, "Geometry Utilities (mathutils.geometry)")
+ del module
import blf as module
pymodule2sphinx(BASEPATH, "blf", module, "Font Drawing (blf)")
del module
+ # XXX TODO
+ #import bgl as module
+ #pymodule2sphinx(BASEPATH, "bgl", module, "Blender OpenGl wrapper (bgl)")
+ #del module
+
import aud as module
pymodule2sphinx(BASEPATH, "aud", module, "Audio System (aud)")
del module