pydoc.TextDoc

class pydoc.TextDoc[source]

Formatter class for text documentation.

Methods

_docdescriptor(name, value, mod)
bold(text) Format a string in bold by overstriking.
docclass(object[, name, mod]) Produce text documentation for a given class object.
docdata(object[, name, mod, cl]) Produce text documentation for a data descriptor.
docmodule(object[, name, mod]) Produce text documentation for a given module object.
docother(object[, name, mod, parent, ...]) Produce text documentation for a data object.
docproperty(object[, name, mod, cl]) Produce text documentation for a property.
docroutine(object[, name, mod, cl]) Produce text documentation for a function or method object.
document(object[, name]) Generate documentation for an object.
fail(object[, name]) Raise an exception for unimplemented types.
formattree(tree, modname[, parent, prefix]) Render in text a class tree as returned by inspect.getclasstree().
formatvalue(object) Format an argument default value as text.
getdocloc(object) Return the location of module docs or None
indent(text[, prefix]) Indent text by prepending a given prefix to each line.
repr(x)
section(title, contents) Format a section with a given heading.