You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Bar.attr1 is not documented. It will be shown if I give :undoc-members: option to the autoclass directive call. It seems the attribute is treated as undocumented.
Expected behavior
It should be shown.
Your project
No
Screenshots
No
Environment info
OS: Mac
Python version: 3.9.1
Sphinx version: HEAD of 3.x
Sphinx extensions: sphinx.ext.autodoc
Extra tools: No
Additional context
No
The text was updated successfully, but these errors were encountered:
…are recognized as undocumented
Unintentionally, uninitialized attributes defined at superclasses are
recognized as undocumented in the filtering step. Therefore, they are
filtered if `:undoc-members:` option given.
…are recognized as undocumented
Unintentionally, uninitialized attributes defined at superclasses are
recognized as undocumented in the filtering step. Therefore, they are
filtered if `:undoc-members:` option given.
Describe the bug
autodoc: The annotation only member in superclass is treated as "undocumented".
To Reproduce
Bar.attr1
is not documented. It will be shown if I give:undoc-members:
option to the autoclass directive call. It seems the attribute is treated as undocumented.Expected behavior
It should be shown.
Your project
No
Screenshots
No
Environment info
Additional context
No
The text was updated successfully, but these errors were encountered: