Create documentation from python modules and other objects.

Short summary:

• is_dunder: Test whether a name is a dunder name (__foo__).

• module_doc: Fetch the docstrings from a module and assemble a MarkDown document.

• obj_docstring: Return a docstring for obj which has been passed through stripped_dedent.

Functions

is_dunder(name)

Test whether a name is a dunder name (__foo__).

module_doc(module, *, sort_key=<function

Fetch the docstrings from a module and assemble a MarkDown document.

Parameters:

• module: the module or module name to inspect
• sort_key: optional key for sorting names in the documentation; default: name
• filter_key`: optional test for a key used to select or reject keys to appear in the documentation
• method_names: optional list of method names to document; the default is to document __init__, then CONSTANTS, the dunders, then other public names

obj_docstring(obj)

Return a docstring for obj which has been passed through stripped_dedent.

This function uses obj.__doc__ if it is not None, otherwise getcomments(obj) if that is not None, otherwise ''. The chosen string is passed through stripped_dedent before return.