sphinx-autodoc-sphinx 0.0.1a0

Sphinx extension for documenting extension config values as first-class conf.py reference entries

sphinx-autodoc-sphinx

Sphinx extension for documenting config values registered by app.add_config_value() as copyable conf.py reference entries.

Install

$ pip install sphinx-autodoc-sphinx

Usage

extensions = ["sphinx_autodoc_sphinx"]

Then document one config value:

```{eval-rst}
.. autoconfigvalue:: sphinx_fonts.sphinx_font_preload
```

Or generate a full reference section for an extension module:

.. autoconfigvalue-index:: sphinx_fonts
.. autoconfigvalues:: sphinx_fonts

.. autosphinxconfig-index:: sphinx_argparse_neo.exemplar

Documentation

See the full documentation for live demos, generated confval entries, and downstream usage patterns.