docs.ext.script_documenter module
- class docs.ext.script_documenter.ScriptClassDocumenter(*args)[source]
Bases:
ClassDocumenter- Parameters:
args (Any) –
- add_content(more_content, no_docstring=False)[source]
Add content from docstrings, attribute documentation and user.
- Parameters:
more_content (StringList | None) –
no_docstring (bool) –
- Return type:
None
- add_directive_header(sig)[source]
Add the directive header and options to the generated content.
- Parameters:
sig (str) –
- Return type:
None
- directivetype = 'scriptinfoclass'
- objtype = 'scriptinfoclass'
name by which the directive is called (auto…) and the default generated directive name
- priority = 14
priority if multiple documenters return True from can_document_member
- titles_allowed = True
true if the generated content may contain titles