From 25bd57b0a1512037070d9e6c85694ab8fa82ec1b Mon Sep 17 00:00:00 2001 From: Campbell Barton Date: Mon, 6 Dec 2010 12:36:55 +0000 Subject: include getset's for generating module docs. used for bpy.debug/tempdir/driver_namespace which were previously undocumented. --- doc/python_api/sphinx_doc_gen.py | 10 ++++++++++ 1 file changed, 10 insertions(+) (limited to 'doc/python_api') 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) -- cgit v1.2.3