update for missing docs & dont include operator classes in sphinx docs.
authorCampbell Barton <ideasman42@gmail.com>
Tue, 16 Feb 2010 15:01:34 +0000 (15:01 +0000)
committerCampbell Barton <ideasman42@gmail.com>
Tue, 16 Feb 2010 15:01:34 +0000 (15:01 +0000)
release/scripts/modules/bpy/utils.py
source/blender/python/doc/sphinx_doc_gen.py
source/blender/python/intern/bpy.c

index f8b66360e39ac32375939a2d40262a9e4e468b1b..1f4866836a13b3da41ad552c958ed2aecf2847b7 100644 (file)
@@ -55,6 +55,13 @@ def _test_import(module_name, loaded_modules):
 def modules_from_path(path, loaded_modules):
     """
     Load all modules in a path and return them as a list.
+
+    :arg path: this path is scanned for scripts and packages.
+    :type path: string
+    :arg loaded_modules: alredy loaded module names, files matching these names will be ignored.
+    :type loaded_modules: set
+    :return: all loaded modules.
+    :rtype: list
     """
     import traceback
     import time
@@ -81,6 +88,14 @@ _bpy_types = __import__("bpy_types") # keep for comparisons, never ever reload t
 
 
 def load_scripts(reload_scripts=False, refresh_scripts=False):
+    """
+    Load scripts and run each modules register function.
+    
+    :arg reload_scripts: Causes all scripts to have their unregister method called before loading.
+    :type reload_scripts: bool
+    :arg refresh_scripts: only load scripts which are not already loaded as modules.
+    :type refresh_scripts: bool
+    """
     import traceback
     import time
 
index e0cded8af85c6954e3d5a911add3a389250b9d98..e3258a1565520063c156f3c40be9602dd9566386 100644 (file)
@@ -447,6 +447,9 @@ def rna2sphinx(BASEPATH):
 
 
     for struct in structs.values():
+        # TODO, rna_info should filter these out!
+        if "_OT_" in struct.identifier:
+            continue
         write_struct(struct)
 
     # oeprators
index 49fac74bce832b07311899c3e332596b1cf6e774..43accf939aa02903ea8b7f792206fd493037c4e8 100644 (file)
 #include "../generic/Geometry.h"
 #include "../generic/BGL.h"
 #include "../generic/IDProp.h"
-/* todo, make nice syntax for sphinx */
-static char bpy_home_paths_doc[] = "home_paths(subfolder), return 3 paths to blender home directories (system, local, user), strings will be empty when not found.";
+
+static char bpy_home_paths_doc[] =
+".. function:: home_paths(subfolder)\n"
+"\n"
+"   return 3 paths to blender home directories.\n"
+"\n"
+"   :arg subfolder: The name of a subfolder to find within the blenders home directory.\n"
+"   :type subfolder: string\n"
+"   :return: (system, local, user) strings will be empty when not found.\n"
+"   :rtype: tuple of strigs\n";
 
 PyObject *bpy_home_paths(PyObject *self, PyObject *args)
 {