diff options
| -rw-r--r-- | CHANGES | 3 | ||||
| -rw-r--r-- | sphinx/ext/napoleon/docstring.py | 8 | ||||
| -rw-r--r-- | tests/test_ext_napoleon_docstring.py | 9 |
3 files changed, 16 insertions, 4 deletions
@@ -22,6 +22,9 @@ Bugs fixed - sphinx.application.CONFIG_FILENAME - :confval:`viewcode_import` +* #6220, #6225: napoleon: AttributeError is raised for raised section having + references + Testing -------- diff --git a/sphinx/ext/napoleon/docstring.py b/sphinx/ext/napoleon/docstring.py index 00a41afe8..0fea99fb8 100644 --- a/sphinx/ext/napoleon/docstring.py +++ b/sphinx/ext/napoleon/docstring.py @@ -100,7 +100,7 @@ class GoogleDocstring: """ - _name_rgx = re.compile(r"^\s*(:(?P<role>\w+):`(?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) def __init__(self, docstring, config=None, app=None, what='', name='', @@ -700,9 +700,9 @@ class GoogleDocstring: fields = self._consume_fields(parse_type=False, prefer_type=True) lines = [] # type: List[str] for _name, _type, _desc in fields: - m = self._name_rgx.match(_type).groupdict() - if m['role']: - _type = m['name'] + m = self._name_rgx.match(_type) + if m and m.group('name'): + _type = m.group('name') _type = ' ' + _type if _type else '' _desc = self._strip_empty(_desc) _descs = ' ' + '\n '.join(_desc) if any(_desc) else '' diff --git a/tests/test_ext_napoleon_docstring.py b/tests/test_ext_napoleon_docstring.py index 86ded7d89..a333dc47b 100644 --- a/tests/test_ext_napoleon_docstring.py +++ b/tests/test_ext_napoleon_docstring.py @@ -473,12 +473,21 @@ Raises: A setting wasn't specified, or was invalid. ValueError: Something something value error. + :py:class:`AttributeError` + errors for missing attributes. + ~InvalidDimensionsError + If the dimensions couldn't be parsed. + `InvalidArgumentsError` + If the arguments are invalid. """, """ Example Function :raises RuntimeError: A setting wasn't specified, or was invalid. :raises ValueError: Something something value error. +:raises AttributeError: errors for missing attributes. +:raises ~InvalidDimensionsError: If the dimensions couldn't be parsed. +:raises InvalidArgumentsError: If the arguments are invalid. """), ################################ (""" |