mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2026-08-07 11:45:10 -05:00
Merge branch '3.4.x' into 3.x
This commit is contained in:
@@ -19,7 +19,7 @@ Bugs fixed
|
||||
Testing
|
||||
--------
|
||||
|
||||
Release 3.4.1 (in development)
|
||||
Release 3.4.2 (in development)
|
||||
==============================
|
||||
|
||||
Dependencies
|
||||
@@ -37,16 +37,25 @@ Features added
|
||||
Bugs fixed
|
||||
----------
|
||||
|
||||
Testing
|
||||
--------
|
||||
|
||||
Release 3.4.1 (released Dec 25, 2020)
|
||||
=====================================
|
||||
|
||||
Bugs fixed
|
||||
----------
|
||||
|
||||
* #8559: autodoc: AttributeError is raised when using forward-reference type
|
||||
annotations
|
||||
* #8568: autodoc: TypeError is raised on checking slots attribute
|
||||
* #8567: autodoc: Instance attributes are incorrectly added to Parent class
|
||||
* #8566: autodoc: The ``autodoc-process-docstring`` event is emitted to the
|
||||
alias classes unexpectedly
|
||||
* #8583: autodoc: Unnecessary object comparision via ``__eq__`` method
|
||||
* #8565: linkcheck: Fix PriorityQueue crash when link tuples are not
|
||||
comparable
|
||||
|
||||
Testing
|
||||
--------
|
||||
|
||||
Release 3.4.0 (released Dec 20, 2020)
|
||||
=====================================
|
||||
|
||||
|
||||
@@ -586,10 +586,12 @@ class Documenter:
|
||||
def add_content(self, more_content: Optional[StringList], no_docstring: bool = False
|
||||
) -> None:
|
||||
"""Add content from docstrings, attribute documentation and user."""
|
||||
if no_docstring:
|
||||
warnings.warn("The 'no_docstring' argument to %s.add_content() is deprecated."
|
||||
% self.__class__.__name__,
|
||||
RemovedInSphinx50Warning, stacklevel=2)
|
||||
# Suspended temporarily (see https://github.com/sphinx-doc/sphinx/pull/8533)
|
||||
#
|
||||
# if no_docstring:
|
||||
# warnings.warn("The 'no_docstring' argument to %s.add_content() is deprecated."
|
||||
# % self.__class__.__name__,
|
||||
# RemovedInSphinx50Warning, stacklevel=2)
|
||||
|
||||
# set sourcename and add content from attribute documentation
|
||||
sourcename = self.get_sourcename()
|
||||
@@ -1660,8 +1662,9 @@ class ClassDocumenter(DocstringSignatureMixin, ModuleLevelDocumenter): # type:
|
||||
) -> None:
|
||||
if self.doc_as_attr:
|
||||
more_content = StringList([_('alias of %s') % restify(self.object)], source='')
|
||||
|
||||
super().add_content(more_content)
|
||||
super().add_content(more_content, no_docstring=True)
|
||||
else:
|
||||
super().add_content(more_content)
|
||||
|
||||
def document_members(self, all_members: bool = False) -> None:
|
||||
if self.doc_as_attr:
|
||||
@@ -1827,7 +1830,7 @@ class UninitializedGlobalVariableMixin(DataDocumenterMixinBase):
|
||||
return False
|
||||
|
||||
def should_suppress_value_header(self) -> bool:
|
||||
return (self.object == UNINITIALIZED_ATTR or
|
||||
return (self.object is UNINITIALIZED_ATTR or
|
||||
super().should_suppress_value_header())
|
||||
|
||||
def get_doc(self, encoding: str = None, ignore: int = None) -> List[List[str]]:
|
||||
|
||||
Reference in New Issue
Block a user