References for config file values #7859
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is another suggestion for adding crossrefs to the docs, a follow-up of #7652 (crossrefs to standard library items) and #7784 (crossrefs for command line options), only now for the config file values.
Since Sphinx doesn't define any config-specific role, I have added the special
confval
directive and role. The.. confval::
directive accepts two optional info fields,:type:
and:default:
. For example,renders as
The
:confval:
role adds a crossref to the config value in a similar fashion as the:option:
role for command line options. Example:renders as

If you like this suggestion, I will add another PR that adds crossreferences to the config file values throughout the docs.