API Reference

Directive reference

Generated from app.add_directive() registrations in sphinx_autodoc_sphinx/__init__.py via sphinx-autodoc-docutils — a meta-loop where the package that documents config values uses its sibling package to document its own directives.

.. autoconfigvalue::

directive

directive

.. autoconfigvalue::

Render one config value from a fully-qualified module.option path.

Options:

Python path:

sphinx_autodoc_sphinx._directives.AutoconfigvalueDirective

Required arguments:

1

Optional arguments:

0

Final argument whitespace:

False

Has content:

False

:no-index:

option

option

:no-index:

Validator: flag.

.. autoconfigvalues::

directive

directive

.. autoconfigvalues::

Render all config values registered by one extension module.

Options:

Python path:

sphinx_autodoc_sphinx._directives.AutoconfigvaluesDirective

Required arguments:

1

Optional arguments:

0

Final argument whitespace:

False

Has content:

False

:no-index:

option

option

:no-index:

Validator: flag.