-
-
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
Sphinx 2.0: napoleon extension fails to parse exception with tilde #6220
Comments
I found a similar error when parsing a section where the exception was enclosed in backquotes, ie: Raises:
`SomeError` |
@tk0miya I must apologize. I no longer have the time to maintain Napoleon. I probably should have said something sooner. |
@RobRuana Don't mind. I'll try to maintain it. Thank you for letting me know |
tk0miya
added a commit
to tk0miya/sphinx
that referenced
this issue
Mar 31, 2019
…sed for raised section having references
I just posted #6237 to resolve this :-) |
tk0miya
added a commit
to tk0miya/sphinx
that referenced
this issue
Mar 31, 2019
…sed for raised section having references
Fixed by #6237. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Describe the bug
Using the napoleon extension with
napoleon_numpy_docstring = False
, an exception with a tilde in front fails to parse.I have a docstring
This regex fails:
sphinx/sphinx/ext/napoleon/docstring.py
Lines 103 to 104 in 1499a97
at this line:
sphinx/sphinx/ext/napoleon/docstring.py
Line 703 in 1499a97
To Reproduce
Expected behavior
Sphinx renders it as if I used
:raises ~mymodule.MyError: description.
Environment info
Additional context
Bug introduced by #4046
The text was updated successfully, but these errors were encountered: