mirror of
https://github.com/beetbox/beets.git
synced 2025-12-06 08:39:17 +01:00
a938449b29
Create a custom Sphinx extension to document configuration values with
a simplified syntax. It is based on the `confval` but takes less space
when rendered. The extension provides:
- A `conf` directive for documenting individual configuration values
with optional type and default parameters
- A `conf` role for cross-referencing configuration values
- Automatic formatting of default values in the signature
- A custom domain that handles indexing and cross-references
For example, if we have
.. conf:: search_limit
:default: 5
We refer to this configuration option with :conf:`plugins.discogs:search_limit`.
The extension is loaded by adding the docs/extensions directory to the
Python path and registering it in the Sphinx extensions list.
|
||
|---|---|---|
| .. | ||
| _static | ||
| _templates/autosummary | ||
| api | ||
| dev | ||
| extensions | ||
| guides | ||
| plugins | ||
| reference | ||
| .gitignore | ||
| changelog.rst | ||
| code_of_conduct.rst | ||
| conf.py | ||
| contributing.rst | ||
| faq.rst | ||
| index.rst | ||
| Makefile | ||
| modd.conf | ||
| team.rst | ||