Skip to content

Commit

Permalink
Fix #8200: autodoc: type aliases break type formatting
Browse files Browse the repository at this point in the history
The annotation option is shared between auto directives unexpectedly.
It causes supression of type annotations for objects after
GenericAlias definition.
  • Loading branch information
tk0miya committed Oct 3, 2020
1 parent 88b81a0 commit a555e3d
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 2 deletions.
1 change: 1 addition & 0 deletions CHANGES
Expand Up @@ -34,6 +34,7 @@ Bugs fixed
by string not ending with blank lines
* #8142: autodoc: Wrong constructor signature for the class derived from
typing.Generic
* #8200: autodoc: type aliases break type formatting of autoattribute
* #8192: napoleon: description is disappeared when it contains inline literals
* #8142: napoleon: Potential of regex denial of service in google style docs
* #8169: LaTeX: pxjahyper loaded even when latex_engine is not platex
Expand Down
6 changes: 4 additions & 2 deletions sphinx/ext/autodoc/__init__.py
Expand Up @@ -1731,7 +1731,8 @@ def can_document_member(cls, member: Any, membername: str, isattr: bool, parent:
return inspect.isgenericalias(member)

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)

def add_content(self, more_content: Any, no_docstring: bool = False) -> None:
Expand All @@ -1755,7 +1756,8 @@ def can_document_member(cls, member: Any, membername: str, isattr: bool, parent:
return isinstance(member, TypeVar) and isattr # type: ignore

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)

def get_doc(self, encoding: str = None, ignore: int = None) -> List[List[str]]:
Expand Down

0 comments on commit a555e3d

Please sign in to comment.