sphinx.ext.autodoc.directive

module documentation
(source)

Undocumented

Class AutodocDirective A directive class for all autodoc directives. It works as a dispatcher of Documenters.
Class DocumenterBridge A parameters container for Documenters.
Class DummyOptionSpec An option_spec allows any options.
Function parse_generated_content Parse an item of content generated by Documenter.
Function process_documenter_options Recognize options of Documenter from user input.
Constant AUTODOC_DEFAULT_OPTIONS Undocumented
Constant AUTODOC_EXTENDABLE_OPTIONS Undocumented
Variable logger Undocumented
def parse_generated_content(state, content, documenter): (source)

Parse an item of content generated by Documenter.

Parameters
state:RSTStateUndocumented
content:StringListUndocumented
documenter:DocumenterUndocumented
Returns
list[Node]Undocumented
def process_documenter_options(documenter, config, options): (source)

Recognize options of Documenter from user input.

Parameters
documenter:type[Documenter]Undocumented
config:ConfigUndocumented
options:dictUndocumented
Returns
OptionsUndocumented
AUTODOC_DEFAULT_OPTIONS: list[str] = (source)

Undocumented

Value
['members',
 'undoc-members',
 'inherited-members',
 'show-inheritance',
 'private-members',
 'special-members',
 'ignore-module-all',
...
AUTODOC_EXTENDABLE_OPTIONS: list[str] = (source)

Undocumented

Value
['members', 'private-members', 'special-members', 'exclude-members']
logger = (source)

Undocumented