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 #9504: autodoc: generate incorrect reference to the parent class

Browse Source 
Autodoc generates incorrect references to the parent class the target
class inherites the class having `_name` attribute.  It conciders the
parent is a kind of SpecialForm'ed class by mistake.  This uses
`isinstance(X, SpecialForm)` to check that.

Note: SpecialForm became a class since Python 3.7.
This commit is contained in:
Takeshi KOMIYA 2021-07-31 01:41:35 +09:00
parent 1fd5f74653
commit d0c97e9eb5
2 changed files with 4 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
CHANGES
View File

@ -16,6 +16,8 @@ Features added
Bugs fixed
----------
* #9504: autodoc: generate incorrect reference to the parent class if the target
class inherites the class having ``_name`` attribute
* #9512: sphinx-build: crashed with the HEAD of Python 3.10
Testing

8
sphinx/util/typing.py
View File

@ -171,12 +171,8 @@ def _restify_py37(cls: Optional[Type]) -> str:
text += r"\ [%s]" % ", ".join(restify(a) for a in cls.__args__)
return text
elif hasattr(cls, '_name'):
# SpecialForm
if cls.__module__ == 'typing':
return ':obj:`~%s.%s`' % (cls.__module__, cls._name)
else:
return ':obj:`%s.%s`' % (cls.__module__, cls._name)
elif isinstance(cls, typing._SpecialForm):
return ':obj:`~%s.%s`' % (cls.__module__, cls._name)
elif hasattr(cls, '__qualname__'):
if cls.__module__ == 'typing':
return ':class:`~%s.%s`' % (cls.__module__, cls.__qualname__)