Note

This page is a reference documentation. It only explains the function signature, and not how to use it. Please refer to the user guide for the big picture.

pysphinxdoc.utils.getmembers

pysphinxdoc.utils.getmembers(module)

Recursively find all the members of a module, and try to apply the selection defined in the ‘__all__’ attribute.

Parameters:

mod: ModuleType

a module.

Returns:

members: dict

structure containing the module names as keys and the associated classes and functions names.