tmaq
/
tornavis
1
0
Fork 0
Code Issues 2 Pull Requests 29 Packages Projects 24 Releases Wiki Activity

reference docs: include type info with function return values

This commit is contained in:
Campbell Barton 2010-01-18 10:45:54 +00:00
parent e723b060fc
commit fe67b9d6f2
1 changed files with 7 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
source/blender/python/sphinx_doc_gen.py
View File

@ -98,14 +98,18 @@ def rna2sphinx(BASEPATH):
if is_return:
id_name = "return"
id_type = "rtype"
kwargs = {"as_ret": True, "class_fmt": ":class:`%s`"}
identifier = ""
else:
id_name = "arg"
id_type = "type"
kwargs = {"as_arg": True, "class_fmt": ":class:`%s`"}
identifier = " %s" % prop.identifier
type_descr = prop.get_type_description(as_arg=True, class_fmt=":class:`%s`")
type_descr = prop.get_type_description(**kwargs)
if prop.name or prop.description:
fw(ident + ":%s %s: %s\n" % (id_name, prop.identifier, ", ".join([val for val in (prop.name, prop.description) if val])))
fw(ident + ":%s %s: %s\n" % (id_type, prop.identifier, type_descr))
fw(ident + ":%s%s: %s\n" % (id_name, identifier, ", ".join([val for val in (prop.name, prop.description) if val])))
fw(ident + ":%s%s: %s\n" % (id_type, identifier, type_descr))
def write_struct(struct):
#if not struct.identifier.startswith("Sc") and not struct.identifier.startswith("I"):