-
Notifications
You must be signed in to change notification settings - Fork 54
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Set the default_role to any #74
Comments
Any downside to this? It sounds good to me. |
I don't know that these are valid downsides, but I could imagine:
That said, Sphinx makes it pretty easy to customize the behavior of the default role if we needed to (eg. to prefer terms over variables, or vice versa). |
Yeah, those seem pretty easy-to-work-around downsides for the benefits. Have we searched the current codebase for instances of using backticks for emphasis? |
Just did (it was easy to find them—I just defined a custom role that raised an error message and set the default_role to that). All but one case actually used it in error, and most cases should have used double-backticks instead. (I imagine the author probably was used to Markdown, or this was due to a conversion error.) Fixed all cases in 18d6571. |
It can be quite tedious (and hurt readability) to keep typing out the roles for external references:
Sphinx allows you to set the default_role, which will be used whenever single backticks are used without a prefix. I suggest setting it to
:any:
, which will make Sphinx automatically figure out what you are talking about and link it as appropriate. I think we can get the above down to::any:
will also find glossary terms, or really any kind of reference (as the name suggests), which might be useful in text that is continuously referring to things like`render`
or other Panda-specific terms.Thoughts?
The text was updated successfully, but these errors were encountered: