doc: replace describe by confval #12186
Draft
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
`confval` generates anchors when `describe` does not. Signed-off-by: Etienne Marais <[email protected]>
|
I am not a fan of these reference names colliding. Would it be possible to introduce our own directive similar to describe and confval where we can make the reference value a bit more qualified so we don't get these conflicts? |
|
That's a good question. It may be possible but my understanding is it would require to code it in Python. I'm not enough aware of Sphinx possibilities to provide a confident answer. The PR was mostly to open the question. If we can extend it without having to write a full library, it would be clean! EDIT: I converted the issue to DRAFT to make it clear not to merge it and give time to investigate. |
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 PR tries to address some parts of #12156.
confvalgenerates anchors whendescribedoes not. It might generate warnings due to references existing twice. It doesn't affect our use case, but, it could be a problem at some point if we directly use theconfvalin our refs.