Metadata-Version: 2.4
Name: sphinx-autodoc-sphinx
Version: 0.0.1a26
Summary: Sphinx extension for documenting extension config values as first-class conf.py reference entries
Project-URL: Repository, https://github.com/git-pull/gp-sphinx
Author-email: Tony Narlock <tony@git-pull.com>
License: MIT
Keywords: autodoc,conf.py,configuration,documentation,sphinx
Classifier: Development Status :: 3 - Alpha
Classifier: Framework :: Sphinx
Classifier: Framework :: Sphinx :: Extension
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Documentation
Classifier: Topic :: Documentation :: Sphinx
Classifier: Typing :: Typed
Requires-Python: <4.0,>=3.10
Requires-Dist: sphinx-autodoc-typehints-gp==0.0.1a26
Requires-Dist: sphinx-ux-autodoc-layout==0.0.1a26
Requires-Dist: sphinx-ux-badges==0.0.1a26
Requires-Dist: sphinx>=8.1
Description-Content-Type: text/markdown

# sphinx-autodoc-sphinx

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

Rendered entries use the shared stack: `sphinx_ux_autodoc_layout` owns the
visible `api-*` structure, `sphinx_ux_badges` owns badge output, and
`sphinx_autodoc_typehints_gp` is auto-loaded so displayed config types follow the same
annotation rules as the rest of the autodoc family.

## Install

```console
$ pip install sphinx-autodoc-sphinx
```

## Usage

```python
extensions = ["sphinx_autodoc_sphinx"]
```

Then document one config value:

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

Or generate a full reference section for an extension module:

```rst
.. autoconfigvalues:: sphinx_fonts
```

## Documentation

See the [full documentation](https://gp-sphinx.git-pull.com/packages/sphinx-autodoc-sphinx/)
for live demos, generated `confval` entries, and downstream usage patterns.
