pydoc.HTMLDoc

class pydoc.HTMLDoc[source]

Formatter class for HTML documentation.

Methods

_docdescriptor(name, value, mod)
bigsection(title, *args) Format a section with a big heading.
classlink(object, modname) Make a link for a class.
docclass(object[, name, mod, funcs, classes]) Produce HTML documentation for a class object.
docdata(object[, name, mod, cl]) Produce html documentation for a data descriptor.
docmodule(object[, name, mod]) Produce HTML documentation for a module object.
docother(object[, name, mod]) Produce HTML documentation for a data object.
docproperty(object[, name, mod, cl]) Produce html documentation for a property.
docroutine(object[, name, mod, funcs, ...]) Produce HTML documentation for a function or method object.
document(object[, name]) Generate documentation for an object.
escape(text)
fail(object[, name]) Raise an exception for unimplemented types.
formattree(tree, modname[, parent]) Produce HTML for a class tree as given by inspect.getclasstree().
formatvalue(object) Format an argument default value as text.
getdocloc(object) Return the location of module docs or None
grey(text)
heading(title, fgcol, bgcol[, extras]) Format a page heading.
index(dir[, shadowed]) Generate an HTML index for a directory of modules.
markup(text[, escape, funcs, classes, methods]) Mark up some plain text, given a context of symbols to look for.
modpkglink(data) Make a link for a module or package to display in an index.
modulelink(object) Make a link for a module.
multicolumn(list, format[, cols]) Format a list of items into a multi-column list.
namelink(name, *dicts) Make a link for an identifier, given name-to-URL mappings.
page(title, contents) Format an HTML page.
preformat(text) Format literal preformatted text.
repr(object)
section(title, fgcol, bgcol, contents[, ...]) Format a section with a heading.