References for config file values #7859
Merged
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
…ile.rst Signed-off-by: Oleg Höfling <oleg.hoefling@gmail.com>
hoefling
commented
Nov 2, 2019
| .. _config-precedence: | ||
|
|
||
| When options conflict, the precedence order for configuration is: | ||
|
|
There was a problem hiding this comment.
This newline is not related to this PR's topic, but it fixes a small rendering issue. Right now on current master, the list is rendered like this:
This is because the list items are too deeply indented. With a proper separation of the list and the preceding paragraph, it becomes
Signed-off-by: Oleg Höfling <oleg.hoefling@gmail.com>
JukkaL
approved these changes
Jul 31, 2020
|
@JukkaL awesome, thanks! I will then prepare (or better to say, blow the dust off of) an another PR that will add crossrefs for config values in the current docs. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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
confvaldirective 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.