torx.plotting.

autodoc_module

autodoc_module(mod_name)

Automatically create nice documentation for modules.

Must be called at the end of the module file after all definitions. Does NOT print anything on import.

Parameters:

mod_name (str) – The name of the module to autodoc. Should always be passed as __name__ from within the module itself.

Examples

# At the bottom of your module file: from torx.decorators import autodoc_module autodoc_module(__name__)

# After importing: >>> import torx >>> torx # Shows rich documentation >>> torx.help() # Explicit help