From 768f20d537967ada2c5e71c05b027533959bdc91 Mon Sep 17 00:00:00 2001 From: Campbell Barton Date: Tue, 16 Feb 2010 15:01:34 +0000 Subject: update for missing docs & dont include operator classes in sphinx docs. --- source/blender/python/doc/sphinx_doc_gen.py | 3 +++ source/blender/python/intern/bpy.c | 13 ++++++++++--- 2 files changed, 13 insertions(+), 3 deletions(-) (limited to 'source') diff --git a/source/blender/python/doc/sphinx_doc_gen.py b/source/blender/python/doc/sphinx_doc_gen.py index e0cded8af85..e3258a15655 100644 --- a/source/blender/python/doc/sphinx_doc_gen.py +++ b/source/blender/python/doc/sphinx_doc_gen.py @@ -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 diff --git a/source/blender/python/intern/bpy.c b/source/blender/python/intern/bpy.c index 49fac74bce8..43accf939aa 100644 --- a/source/blender/python/intern/bpy.c +++ b/source/blender/python/intern/bpy.c @@ -39,9 +39,16 @@ #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) { -- cgit v1.2.3