diff options
author | Luca Bonavita <mindrones@gmail.com> | 2010-06-03 01:28:17 +0400 |
---|---|---|
committer | Luca Bonavita <mindrones@gmail.com> | 2010-06-03 01:28:17 +0400 |
commit | e58bb562d22f5c36a49274d22086565132a6459e (patch) | |
tree | 4eb0d22943487fede38fff25e1c9cac1d8bec7a0 /source/blender/python | |
parent | cb26b4d7b957c339fc6df26bab40f30d7fb7d4da (diff) |
== python api docs ==
* source/blender/python/doc/sphinx_doc_gen.py
changed syntax for declating attributes type to use :type: instead of *type* os it
* source/gameengine/Ketsji/KX_PythonInit.cpp
While documenting I've found that we have two naming conventions for constraints in BGE python api,
example: KX_CONSTRAINTACT_DIRPZ and KX_ACT_CONSTRAINT_FHPX: the right convention is KX_CONSTRAINTACT_xxx
After talking with dalai and cambpell we agreed that this kind of change is better suited for NExyon GSoC
so I marked as TODO
Also, found 2 duplicate rows, fixed after askin nexyon
* source/gameengine/PyDoc/bge.logic.rst
there were 2 blocks for constraints, I've put them together in docs and fixed some other lines
* source/gameengine/PyDoc/bge.types.rst
first cleanup: mainly started using ":type:", it was mixed usage of *type* and **type**
started cleaning some bullet list in a way that varibles link to the constant in appropriate page
I'll continue later
Diffstat (limited to 'source/blender/python')
-rw-r--r-- | source/blender/python/doc/sphinx_doc_gen.py | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/source/blender/python/doc/sphinx_doc_gen.py b/source/blender/python/doc/sphinx_doc_gen.py index 9044212ac4d..e165e597f31 100644 --- a/source/blender/python/doc/sphinx_doc_gen.py +++ b/source/blender/python/doc/sphinx_doc_gen.py @@ -511,7 +511,7 @@ def rna2sphinx(BASEPATH): if prop.description: fw(" %s\n\n" % prop.description) type_descr = prop.get_type_description(class_fmt=":class:`%s`") - fw(" *type* %s\n\n" % type_descr) + fw(" :type: %s\n\n" % type_descr) # python attributes py_properties = struct.get_py_properties() |