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>2011-11-05 05:48:10 +0400
committerCampbell Barton <ideasman42@gmail.com>2011-11-05 05:48:10 +0400
commit057bf2a02bd453ac8dd5048baa298de39f213560 (patch)
tree3b602cd29d07d2755e2ee078d9663535fefa6f0d /doc
parent6483069a84fc335283ffe400f5a85c9be46a0a80 (diff)
misc doc edits
- remove recently added sphinx reference workaround. - tested doxygen, correct some warnings, set tab width and added pymathutils group. - added convenience target 'make doc_doxy'
Diffstat (limited to 'doc')
-rw-r--r--doc/doxygen/Doxyfile2
-rw-r--r--doc/doxygen/doxygen.source4
-rw-r--r--doc/python_api/sphinx_doc_gen.py21
3 files changed, 11 insertions, 16 deletions
diff --git a/doc/doxygen/Doxyfile b/doc/doxygen/Doxyfile
index b4d3b14b9dd..dd112ed6a48 100644
--- a/doc/doxygen/Doxyfile
+++ b/doc/doxygen/Doxyfile
@@ -193,7 +193,7 @@ SEPARATE_MEMBER_PAGES = NO
# The TAB_SIZE tag can be used to set the number of spaces in a tab.
# Doxygen uses this value to replace tabs by spaces in code fragments.
-TAB_SIZE = 8
+TAB_SIZE = 4
# This tag can be used to specify a number of aliases that acts
# as commands in the documentation. An alias has the form "name=value".
diff --git a/doc/doxygen/doxygen.source b/doc/doxygen/doxygen.source
index 375234d26a3..cc3a2b14a92 100644
--- a/doc/doxygen/doxygen.source
+++ b/doc/doxygen/doxygen.source
@@ -22,6 +22,10 @@
* \ingroup python
*/
+/** \defgroup pymathutils Python Mathutils
+ * \ingroup python
+ */
+
/** \defgroup pythonintern Python RNA and Operators
* \ingroup python
*/
diff --git a/doc/python_api/sphinx_doc_gen.py b/doc/python_api/sphinx_doc_gen.py
index 3c43b5bc4da..36e092f85b7 100644
--- a/doc/python_api/sphinx_doc_gen.py
+++ b/doc/python_api/sphinx_doc_gen.py
@@ -150,10 +150,6 @@ def is_struct_seq(value):
return isinstance(value, tuple) and type(tuple) != tuple and hasattr(value, "n_fields")
-def module_id_as_ref(name):
- return "mod_" + name.replace(".", "__")
-
-
def undocumented_message(module_name, type_name, identifier):
if str(type_name).startswith('<module'):
preloadtitle = '%s.%s' % (module_name, identifier)
@@ -391,10 +387,6 @@ def pymodule2sphinx(BASEPATH, module_name, module, title):
write_title(fw, "%s (%s)" % (title, module_name), "=")
- # write reference, annoying since we should be able to direct reference the
- # modules but we cant always!
- fw(".. _%s:\n\n" % module_id_as_ref(module_name))
-
fw(".. module:: %s\n\n" % module_name)
if module.__doc__:
@@ -453,20 +445,19 @@ def pymodule2sphinx(BASEPATH, module_name, module, title):
if type(descr) == MemberDescriptorType:
if descr.__doc__:
value = getattr(module, key, None)
+
value_type = type(value)
descr_sorted.append((key, descr, value, type(value)))
# sort by the valye type
descr_sorted.sort(key=lambda descr_data: str(descr_data[3]))
for key, descr, value, value_type in descr_sorted:
- type_name = value_type.__name__
- py_descr2sphinx("", fw, descr, module_name, type_name, key)
+ # must be documented as a submodule
if is_struct_seq(value):
- # ack, cant use typical reference because we double up once here
- # and one fort he module!
- full_name = "%s.%s" % (module_name, type_name)
- fw(" :ref:`%s submodule details <%s>`\n\n\n" % (full_name, module_id_as_ref(full_name)))
- del full_name
+ continue
+
+ type_name = value_type.__name__
+ py_descr2sphinx("", fw, descr, module_name, type_name, key)
attribute_set.add(key)