Autosummary to include instance attributes

[pbudzyns]

Subject: Autosummary to include instance attributes

Feature or Bugfix

• Feature

Detail

• Make sphinx.ext.autosummary to use sphinx.ext.autodoc.get_class_members instead of dir(obj) to discover class members and find instance attributes

Relates

• autosummary does not show info for instance attributes #3257

[pbudzyns]

I haven't noticed that because it was working for my project. For safety I changed it back to old method for modules.

Alternatively I think it would be possible to easily extract static method from autodoc.ModuleDocumenter.get_module_members

sphinx/sphinx/ext/autodoc/__init__.py

Line 1046 in b237e78

def get_module_members(self) -> Dict[str, ObjectMember]:

[tk0miya]

Thank you for update. Merged!

[pelson]

Just checking that I think this now means that dataclasses are being correctly documented with autosummary?

This is quite a big deal IMO, and might be worth publicising a little more. (changelog entry d006c66)