scanpydoc.autosummary_generate_imported#

Generate autosummary docs for imported members.

This extension patches the autosummary extension to generate docs for imported members. It needs to be loaded and autosummary_generate needs to be set to True.

This will hopefully be superseded by the ability to add :imported-members: to autosummary templates in the future. See Sphinx issue 4372.

Functions#

setup(_app)[source]#

Patch autosummary to generate docs for imported members as well.

Parameters
app

Sphinx app to set this extension up for

Return type

dict[str, Any]

Returns

Metadata for this extension.