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

Merge pull request #8274 from tk0miya/8200_typealias_break_type_annotation

Browse Source 
Fix #8200: autodoc: type aliases break type formatting
This commit is contained in:
Takeshi KOMIYA 2020-10-04 23:44:08 +09:00 committed by GitHub
commit a8abb9995f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 5 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
CHANGES
View File

@ -41,6 +41,7 @@ Bugs fixed
typing.Generic typing.Generic
* #8157: autodoc: TypeError is raised when annotation has invalid __args__ * #8157: autodoc: TypeError is raised when annotation has invalid __args__
* #7964: autodoc: Tuple in default value is wrongly rendered * #7964: autodoc: Tuple in default value is wrongly rendered
* #8200: autodoc: type aliases break type formatting of autoattribute
* #8192: napoleon: description is disappeared when it contains inline literals * #8192: napoleon: description is disappeared when it contains inline literals
* #8142: napoleon: Potential of regex denial of service in google style docs * #8142: napoleon: Potential of regex denial of service in google style docs
* #8169: LaTeX: pxjahyper loaded even when latex_engine is not platex * #8169: LaTeX: pxjahyper loaded even when latex_engine is not platex

6
sphinx/ext/autodoc/__init__.py
View File

@ -1736,7 +1736,8 @@ class GenericAliasDocumenter(DataDocumenter):
return inspect.isgenericalias(member) return inspect.isgenericalias(member)
def add_directive_header(self, sig: str) -> None: def add_directive_header(self, sig: str) -> None:
self.options.annotation = SUPPRESS # type: ignore self.options = Options(self.options)
self.options['annotation'] = SUPPRESS
super().add_directive_header(sig) super().add_directive_header(sig)
def add_content(self, more_content: Any, no_docstring: bool = False) -> None: def add_content(self, more_content: Any, no_docstring: bool = False) -> None:
@ -1760,7 +1761,8 @@ class TypeVarDocumenter(DataDocumenter):
return isinstance(member, TypeVar) and isattr # type: ignore return isinstance(member, TypeVar) and isattr # type: ignore
def add_directive_header(self, sig: str) -> None: def add_directive_header(self, sig: str) -> None:
self.options.annotation = SUPPRESS # type: ignore self.options = Options(self.options)
self.options['annotation'] = SUPPRESS
super().add_directive_header(sig) super().add_directive_header(sig)
def get_doc(self, encoding: str = None, ignore: int = None) -> List[List[str]]: def get_doc(self, encoding: str = None, ignore: int = None) -> List[List[str]]: