IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Fix #6999: napoleon: fails to parse tilde in :exc: role

Browse Source
This commit is contained in:
Takeshi KOMIYA 2020-01-09 00:15:27 +09:00
parent ae8fc43024
commit b14439ca48
3 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
CHANGES
View File

@ -45,6 +45,7 @@ Bugs fixed
* #6961: latex: warning for babel shown twice * #6961: latex: warning for babel shown twice
* #6559: Wrong node-ids are generated in glossary directive * #6559: Wrong node-ids are generated in glossary directive
* #6986: apidoc: misdetects module name for .so file inside module * #6986: apidoc: misdetects module name for .so file inside module
* #6999: napoleon: fails to parse tilde in :exc: role
Testing Testing
-------- --------

4
sphinx/ext/napoleon/docstring.py
View File

@ -101,8 +101,8 @@ class GoogleDocstring:
""" """
_name_rgx = re.compile(r"^\s*((?::(?P<role>\S+):)?`(?P<name>[a-zA-Z0-9_.-]+)`|" _name_rgx = re.compile(r"^\s*((?::(?P<role>\S+):)?`(?P<name>~?[a-zA-Z0-9_.-]+)`|"
r" (?P<name2>[a-zA-Z0-9_.-]+))\s*", re.X) r" (?P<name2>~?[a-zA-Z0-9_.-]+))\s*", re.X)
def __init__(self, docstring: Union[str, List[str]], config: SphinxConfig = None, def __init__(self, docstring: Union[str, List[str]], config: SphinxConfig = None,
app: Sphinx = None, what: str = '', name: str = '', app: Sphinx = None, what: str = '', name: str = '',

3
tests/test_ext_napoleon_docstring.py
View File

@ -479,6 +479,8 @@ Raises:
If the dimensions couldn't be parsed. If the dimensions couldn't be parsed.
`InvalidArgumentsError` `InvalidArgumentsError`
If the arguments are invalid. If the arguments are invalid.
:exc:`~ValueError`
If the arguments are wrong.
""", """ """, """
Example Function Example Function
@ -488,6 +490,7 @@ Example Function
:raises AttributeError: errors for missing attributes. :raises AttributeError: errors for missing attributes.
:raises ~InvalidDimensionsError: If the dimensions couldn't be parsed. :raises ~InvalidDimensionsError: If the dimensions couldn't be parsed.
:raises InvalidArgumentsError: If the arguments are invalid. :raises InvalidArgumentsError: If the arguments are invalid.
:raises ~ValueError: If the arguments are wrong.
"""), """),
################################ ################################
(""" ("""