-
-
Notifications
You must be signed in to change notification settings - Fork 2.2k
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
Allow inline links in Google style docstrings #11316
Merged
AA-Turner
merged 22 commits into
sphinx-doc:master
from
picnixz:fix/11246-napoleon-allow-top-inline-link
Aug 12, 2023
Merged
Allow inline links in Google style docstrings #11316
AA-Turner
merged 22 commits into
sphinx-doc:master
from
picnixz:fix/11246-napoleon-allow-top-inline-link
Aug 12, 2023
Conversation
This file contains 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
1ff73a6
to
981c507
Compare
After investigation, I also needed to add some escape mechanism for |
3b92c59
to
227e097
Compare
aa0bbfa
to
e4364d9
Compare
Please may you add an entry to CHANGES? |
…:picnixz/sphinx into fix/11246-napoleon-allow-top-inline-link
Thank you ! |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Fix #11246
Detail
sphinx.ext.napoleon
is active.Discussion
In order to allow arbitrary colons that are not meant to separate the documented member type from its description, escaping
:
could be considered (but the parser would require a more careful analysis).Related