diff options
author | Campbell Barton <ideasman42@gmail.com> | 2010-12-06 15:36:55 +0300 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2010-12-06 15:36:55 +0300 |
commit | 25bd57b0a1512037070d9e6c85694ab8fa82ec1b (patch) | |
tree | fa3aecae72fab58003dd7c624e11892a1b0de1a2 | |
parent | d64f46e0bbdd390b2b5487f09638402e7bdfe0e4 (diff) |
include getset's for generating module docs.
used for bpy.debug/tempdir/driver_namespace which were previously undocumented.
-rw-r--r-- | doc/python_api/sphinx_doc_gen.py | 10 | ||||
-rw-r--r-- | source/blender/python/intern/bpy_app.c | 8 |
2 files changed, 14 insertions, 4 deletions
diff --git a/doc/python_api/sphinx_doc_gen.py b/doc/python_api/sphinx_doc_gen.py index c1e614aa23f..1353dcf70d7 100644 --- a/doc/python_api/sphinx_doc_gen.py +++ b/doc/python_api/sphinx_doc_gen.py @@ -224,6 +224,16 @@ def pymodule2sphinx(BASEPATH, module_name, module, title): # write members of the module # only tested with PyStructs which are not exactly modules for key, descr in sorted(type(module).__dict__.items()): + if key.startswith("__"): + continue + # naughty, we also add getset's into PyStructs, this is not typical py but also not incorrect. + if type(descr) == types.GetSetDescriptorType: # 'bpy_app_type' name is only used for examples and messages + py_descr2sphinx("", fw, descr, module_name, "bpy_app_type", key) + attribute_set.add(key) + for key, descr in sorted(type(module).__dict__.items()): + if key.startswith("__"): + continue + if type(descr) == types.MemberDescriptorType: if descr.__doc__: fw(".. data:: %s\n\n" % key) diff --git a/source/blender/python/intern/bpy_app.c b/source/blender/python/intern/bpy_app.c index 21a97462dda..bbcfef4cd30 100644 --- a/source/blender/python/intern/bpy_app.c +++ b/source/blender/python/intern/bpy_app.c @@ -59,10 +59,10 @@ static PyStructSequence_Field app_info_fields[] = { {(char *)"build_revision", (char *)"The subversion revision this blender instance was built with"}, {(char *)"build_platform", (char *)"The platform this blender instance was built for"}, {(char *)"build_type", (char *)"The type of build (Release, Debug)"}, - {(char *)"build_cflags", (char *)""}, - {(char *)"build_cxxflags", (char *)""}, - {(char *)"build_linkflags", (char *)""}, - {(char *)"build_system", (char *)""}, + {(char *)"build_cflags", (char *)"C compiler flags"}, + {(char *)"build_cxxflags", (char *)"C++ compiler flags"}, + {(char *)"build_linkflags", (char *)"Binary linking flags"}, + {(char *)"build_system", (char *)"Build system used"}, {0} }; |