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 #6436: napoleon: "Unknown target name" error

Browse Source
This commit is contained in:
Takeshi KOMIYA 2019-06-09 00:23:18 +09:00
parent f0b1cbb734
commit c4dfc7402e
3 changed files with 7 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
CHANGES
View File

@ -20,6 +20,8 @@ Bugs fixed
immediately preceding section title by pagebreak immediately preceding section title by pagebreak
* #6448: autodoc: crashed when autodocumenting classes with ``__slots__ = None`` * #6448: autodoc: crashed when autodocumenting classes with ``__slots__ = None``
* #6452: autosummary: crashed when generating document of properties * #6452: autosummary: crashed when generating document of properties
* #6436: napoleon: "Unknown target name" error if variable name ends with
underscore
Testing Testing
-------- --------

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

@ -328,6 +328,9 @@ class GoogleDocstring:
def _escape_args_and_kwargs(self, name): def _escape_args_and_kwargs(self, name):
# type: (str) -> str # type: (str) -> str
if name.endswith('_'):
name = name[:-1] + r'\_'
if name[:2] == '**': if name[:2] == '**':
return r'\*\*' + name[2:] return r'\*\*' + name[2:]
elif name[:1] == '*': elif name[:1] == '*':

4
tests/test_ext_napoleon_docstring.py
View File

@ -1351,8 +1351,8 @@ arg_ : type
""" """
expected = """ expected = """
:ivar arg_: some description :ivar arg\\_: some description
:vartype arg_: type :vartype arg\\_: type
""" """
config = Config(napoleon_use_ivar=True) config = Config(napoleon_use_ivar=True)