sphinx.ext.autodoc.directive.AutodocDirective

class documentation

class AutodocDirective(SphinxDirective):

View In Hierarchy

A directive class for all autodoc directives. It works as a dispatcher of Documenters.

It invokes a Documenter upon running. After the processing, it parses and returns the content generated by Documenter.

Method run Undocumented
Class Variable final​_argument​_whitespace Undocumented
Class Variable has​_content Undocumented
Class Variable option​_spec Undocumented
Class Variable optional​_arguments Undocumented
Class Variable required​_arguments Undocumented

Inherited from SphinxDirective:

Method get​_location Get current location info for logging.
Method get​_source​_info Get source and line number.
Method set​_source​_info Set source and line number to the node.
Property config Reference to the .Config object.
Property env Reference to the .BuildEnvironment object.
def run(self):

Undocumented

Returns
List[Node]Undocumented
final_argument_whitespace: bool =

Undocumented

has_content: bool =

Undocumented

option_spec =

Undocumented

optional_arguments: int =

Undocumented

required_arguments: int =

Undocumented