sphinx.ext.autodoc.directive

module documentation

Unknown Field: copyright
Copyright 2007-2022 by the Sphinx team, see AUTHORS.
Unknown Field: license
BSD, see LICENSE for details.

Constant	`AUTODOC_DEFAULT_OPTIONS`	Undocumented
Constant	`AUTODOC_EXTENDABLE_OPTIONS`	Undocumented
Variable	`logger`	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.

AUTODOC_DEFAULT_OPTIONS: list[str] =

Undocumented

Value

['members',
 'undoc-members',
 'inherited-members',
 'show-inheritance',
 'private-members',
 'special-members',
 'ignore-module-all',
...

AUTODOC_EXTENDABLE_OPTIONS: list[str] =

Undocumented

Value

['members', 'private-members', 'special-members', 'exclude-members']

logger =

Undocumented

def parse_generated_content(state, content, documenter):

Parse an item of content generated by Documenter.

def process_documenter_options(documenter, config, options):

Recognize options of Documenter from user input.