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
This issue is a followup of #7948. Sorry, I forgot to open it.
Is your feature request related to a problem? Please describe.
Instance attributes are omitted when using the autosummary, as they cannot be imported. Consider the following class
# contents of test_mod.pyclassTest:
"""Test class"""#: int. Some class attributetest: int=1def__init__(self, a: int):
#: int. An instance attributeself.a=1
autodoc via
.. autoclass:: Test:members:
will document the a attribute, but autosummary via
.. autosummary::
Test.a
Test.test
won't.
Describe the solution you'd like
Instance attributes should be documented, too
Describe alternatives you've considered
it did work before 1dcfc44, i.e. for sphinx<3.1 (although the documentation was omitted).
This issue is a followup of #7948. Sorry, I forgot to open it.
Is your feature request related to a problem? Please describe.
Instance attributes are omitted when using the autosummary, as they cannot be imported. Consider the following class
autodoc
viawill document the
a
attribute, butautosummary
via.. autosummary:: Test.a Test.test
won't.
Describe the solution you'd like
Instance attributes should be documented, too
Describe alternatives you've considered
it did work before 1dcfc44, i.e. for
sphinx<3.1
(although the documentation was omitted).Additional context
The text was updated successfully, but these errors were encountered: