doc: use builtin confval directive, add :type: and :default:
#14012
+124
−83
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Since version 7.4, Sphinx had a standard `confval` directive: https://www.sphinx-doc.org/en/master/usage/domains/standard.html#directive-confval So we can drop our custom one.
Seems good to have it in a structured form.
bluetech
force-pushed
the
doc-confval
branch
from
9ecfcdf to
b47e4e1
Compare
psf-chronographer
bot
added
the
bot:chronographer:provided
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
I noticed that Sphinx now exposes a standard
confvaldirective, so let's use it instead of our own. It also has:type:and:option:options, let's use them too.