autodoc2.sphinx.summary#

Directive to generate a summary of listed objects.

Module Contents#

Classes#

AutodocSummary

Directive to generate a summary of listed objects.

API#

class autodoc2.sphinx.summary.AutodocSummary(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)[source]#

Bases: sphinx.util.docutils.SphinxDirective

Directive to generate a summary of listed objects.

Initialization

has_content = True#
required_arguments = 0#
optional_arguments = 0#
final_argument_whitespace = False#
option_spec: ClassVar[dict[str, Any]] = None#
run() → list[docutils.nodes.Node][source]#