diff options
| author | Campbell Barton <ideasman42@gmail.com> | 2010-02-16 18:01:34 +0300 |
|---|---|---|
| committer | Campbell Barton <ideasman42@gmail.com> | 2010-02-16 18:01:34 +0300 |
| commit | 768f20d537967ada2c5e71c05b027533959bdc91 (patch) | |
| tree | 0b2d3e94b457b463305a85d73797b5c5f17c8094 /source/blender/python/intern/bpy.c | |
| parent | 56b8e37864e4c607b858a154dc8266cde42cde3e (diff) | |
update for missing docs & dont include operator classes in sphinx docs.
Diffstat (limited to 'source/blender/python/intern/bpy.c')
| -rw-r--r-- | source/blender/python/intern/bpy.c | 13 |
1 files changed, 10 insertions, 3 deletions
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) { |