sphinxcontrib.autofile

This file is generated by setuptools-generate. The information comes from pyproject.toml. It provide some metainfo for docs/conf.py to build documents and help2man to build man pages.

Sphinx extension: autofile

sphinxcontrib.autofile.setup(app: Sphinx) → None

Set up.

Parameters:

app (Sphinx) –

Return type:

None

Directive

class sphinxcontrib.autofile.directive.AutofileDirective(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)

Autofiledirective.

has_content = True

May the directive have content?

option_spec = {'members': <class 'str'>, 'prefix': <class 'str'>, 'private-members': <class 'str'>, 'special-members': <class 'str'>, 'template': <class 'str'>, 'undoc-members': <class 'str'>}

Mapping of option names to validator functions.

run() → list[Node]

Run.

Return type:

list[Node]