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 #8030: autodoc: An annotated instance variable is not documented

Browse Source 
Documenter.filter_members() have wrongly considered that an instance
variable not having a docstring should be skipped when
`:inherited-members:` option given.

This fixes the behavior when the instance variable has annotated.

Note: This doest not still detect well for not annotated instance
variables.
This commit is contained in:
Takeshi KOMIYA 2020-08-01 19:45:12 +09:00
parent 5e6da19f0e
commit 6225ffd238
2 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
CHANGES
View File

@ -56,6 +56,8 @@ Bugs fixed
* #904: autodoc: An instance attribute cause a crash of autofunction directive * #904: autodoc: An instance attribute cause a crash of autofunction directive
* #1362: autodoc: ``private-members`` option does not work for class attributes * #1362: autodoc: ``private-members`` option does not work for class attributes
* #7983: autodoc: Generator type annotation is wrongly rendered in py36 * #7983: autodoc: Generator type annotation is wrongly rendered in py36
* #8030: autodoc: An uninitialized annotated instance variable is not documented
when ``:inherited-members:`` option given
* #7839: autosummary: cannot handle umlauts in function names * #7839: autosummary: cannot handle umlauts in function names
* #7865: autosummary: Failed to extract summary line when abbreviations found * #7865: autosummary: Failed to extract summary line when abbreviations found
* #7866: autosummary: Failed to extract correct summary line when docstring * #7866: autosummary: Failed to extract correct summary line when docstring

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

@ -579,6 +579,8 @@ class Documenter:
return True return True
elif name in cls.__dict__: elif name in cls.__dict__:
return False return False
elif name in self.get_attr(cls, '__annotations__', {}):
return False
return False return False