docs_tools

File Purpose: tools related to documentation, e.g. docstrings

Functions

_optdoc(s)	return s, but cleaned up with inspect.cleandoc() then replacing newlines with ' '.
docstring_but_strip_examples(f, *[, ...])	return f.__doc__ but removing all lines after "Examplesn", if present.
format_docstring(*args__format[, ...])	returns a decorator of f which returns f, after updating f.__doc__ via f.__doc__.format(...)
list_objs(root[, types_, recurse_on, ...])	return list of all objects in root that are instances of any of types.
sphinx_docstring(f)	return sphinx docstring for this object.

Classes

DocstringInfo(docstring, *[, kind])

info about a docstring.