include getset's for generating module docs.
authorCampbell Barton <ideasman42@gmail.com>
Mon, 6 Dec 2010 12:36:55 +0000 (12:36 +0000)
committerCampbell Barton <ideasman42@gmail.com>
Mon, 6 Dec 2010 12:36:55 +0000 (12:36 +0000)
used for bpy.debug/tempdir/driver_namespace which were previously undocumented.

doc/python_api/sphinx_doc_gen.py
source/blender/python/intern/bpy_app.c

index c1e614aa23f90bba863347c34735ce515fba5708..1353dcf70d7c83fb261179485caa045f69dcdd42 100644 (file)
@@ -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)
index 21a97462dda6eb71615b77ae62b82be4cf882324..bbcfef4cd3094ba28a4355c96fa6390118583b9c 100644 (file)
@@ -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}
 };