Skip to content

Commit

Permalink
Update CHANGES for PR sphinx-doc#7746
Browse files Browse the repository at this point in the history
  • Loading branch information
tk0miya committed May 30, 2020
1 parent 7b414d0 commit 95e3f12
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 3 deletions.
2 changes: 2 additions & 0 deletions CHANGES
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ Release 3.1.0 (in development)
Dependencies
------------

* #7746: mathjax: Update to 2.7.5

Incompatible changes
--------------------

Expand Down
6 changes: 3 additions & 3 deletions sphinx/ext/autodoc/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -1036,6 +1036,7 @@ class DocstringSignatureMixin:
Mixin for FunctionDocumenter and MethodDocumenter to provide the
feature of reading the signature from the docstring.
"""
_new_docstrings = None # type: List[List[str]]

def _find_signature(self, encoding: str = None) -> Tuple[str, str]:
if encoding is not None:
Expand Down Expand Up @@ -1076,9 +1077,8 @@ def get_doc(self, encoding: str = None, ignore: int = None) -> List[List[str]]:
warnings.warn("The 'encoding' argument to autodoc.%s.get_doc() is deprecated."
% self.__class__.__name__,
RemovedInSphinx40Warning, stacklevel=2)
lines = getattr(self, '_new_docstrings', None)
if lines is not None:
return lines
if self._new_docstrings is not None:
return self._new_docstrings
return super().get_doc(None, ignore) # type: ignore

def format_signature(self, **kwargs: Any) -> str:
Expand Down

0 comments on commit 95e3f12

Please sign in to comment.