Change sphinx default role to "any" - #40
Merged
Merged
Conversation
reyang
approved these changes
Jul 2, 2019
Oberon00
approved these changes
Jul 3, 2019
carlosalberto
approved these changes
Jul 3, 2019
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 changes the sphinx default role so that comments in single-backticks render as literal text and link(!) to the appropriate section of the docs if sphinx can find one.
This recommendation comes from the sphinx docs:
One downside is that sphinx can't find a target for some text it'll emit a warning:
but we can get around this by using double-backticks to specify the
:code:role, which is what we were doing before this change anyway.