module documentation

Roughly page and top level containers
Function document Generate documentation for an object. This also part of the public API of class
Function index Generate an HTML index for a directory of modules.
Function page Format an HTML page.
Function render Compose two functions
def document(the_object, name='', *args):

Generate documentation for an object. This also part of the public API of class

Types of : Module, class, routine, data descriptor, "other" are supported

Modules ignore 1st name.

Public API doesn't call with *args Args are: name, fdict, cdict (name twice?) mod, funcs, classes, mdict, the_object

Parameters
the_object:TypeLikeUndocumented
name:strUndocumented
args:AnyUndocumented
Returns
strUndocumented
def index(directory, shadowed=None):
Generate an HTML index for a directory of modules.
Parameters
directory:strUndocumented
shadowed:Optional[Dict[str, Any]]Undocumented
Returns
strUndocumented
def page(title, contents):

Format an HTML page.

This is part of the public API

Parameters
title:strUndocumented
contents:strUndocumented
Returns
strUndocumented
def render(title, the_object, name):
Compose two functions
Parameters
title:strUndocumented
the_object:TypeLikeUndocumented
name:strUndocumented
Returns
strUndocumented