archive/blender-archive
Archived
1
1
Fork 0
Code Pull Requests Packages Activity

Documentation: Support documenting constructors in class __doc__

Browse Source 
Python types defined in C can now start their docstring with a
`.. class:: TypeName(args)` line, to document their constructor.
In that case the documentation writer is responsible for indenting the
remainder of the docstring by 3 spaces, matching the generated
documentation.
This commit is contained in:
Sybren A. Stüvel
2015-02-01 14:00:37 +01:00
parent 9fa628f35b
commit 2e6e92cf50
1 changed files with 9 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
doc/python_api/sphinx_doc_gen.py
View File

@@ -937,10 +937,16 @@ def pymodule2sphinx(basepath, module_name, module, title):
fw(title_string(heading, heading_char)) fw(title_string(heading, heading_char))
# May need to be its own function # May need to be its own function
fw(".. class:: %s\n\n" % type_name)
if value.__doc__: if value.__doc__:
write_indented_lines(" ", fw, value.__doc__, False) if value.__doc__.startswith(".. class::"):
fw("\n") fw(value.__doc__)
else:
fw(".. class:: %s\n\n" % type_name)
write_indented_lines(" ", fw, value.__doc__, False)
else:
fw(".. class:: %s\n\n" % type_name)
fw("\n")
write_example_ref(" ", fw, module_name + "." + type_name) write_example_ref(" ", fw, module_name + "." + type_name)
descr_items = [(key, descr) for key, descr in sorted(value.__dict__.items()) if not key.startswith("__")] descr_items = [(key, descr) for key, descr in sorted(value.__dict__.items()) if not key.startswith("__")]