Merge pull request #6460 from tk0miya/6436_napoleon_unknown_target_name

Fix #6436: napoleon: "Unknown target name" error

CHANGES

@@ -21,6 +21,8 @@ Bugs fixed
 * #6448: autodoc: crashed when autodocumenting classes with ``__slots__ = None``
 * #6452: autosummary: crashed when generating document of properties
 * #6455: napoleon: docstrings for properties are not processed
+* #6436: napoleon: "Unknown target name" error if variable name ends with
+  underscore
 
 Testing
 --------

sphinx/ext/napoleon/docstring.py

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

tests/test_ext_napoleon_docstring.py

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