autodoc2.sphinx.autodoc

autodoc directive for sphinx.

Module Contents

Classes

AutodocObject

Directive to render a docstring of an object.

Functions

_set_parents

Ensure we setup the correct parent This allows sphinx to properly process the py directives.

API

class autodoc2.sphinx.autodoc.AutodocObject(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)

Bases: sphinx.util.docutils.SphinxDirective

Directive to render a docstring of an object.

Initialization

required_arguments = 1

final_argument_whitespace = False

has_content = True

option_spec: ClassVar[dict[str, Any]] = None

run() → list[docutils.nodes.Node]

autodoc2.sphinx.autodoc._set_parents(env: sphinx.environment.BuildEnvironment, mod: autodoc2.utils.ItemData, klass: autodoc2.utils.ItemData | None) → Generator[None, None, None]

Ensure we setup the correct parent This allows sphinx to properly process the py directives.