Formatter class for HTML documentation.
|
|
|
|
|
page(self,
title,
contents)
Format an HTML page. |
|
|
|
heading(self,
title,
fgcol,
bgcol,
extras='
' )
Format a page heading. |
|
|
|
section(self,
title,
fgcol,
bgcol,
contents,
width=6,
prelude='
' ,
marginalia=None,
gap=' ' )
Format a section with a heading. |
|
|
|
bigsection(self,
title,
*args)
Format a section with a big heading. |
|
|
|
preformat(self,
text)
Format literal preformatted text. |
|
|
|
multicolumn(self,
list,
format,
cols=4)
Format a list of items into a multi-column list. |
|
|
|
|
|
namelink(self,
name,
*dicts)
Make a link for an identifier, given name-to-URL mappings. |
|
|
|
classlink(self,
object,
modname)
Make a link for a class. |
|
|
|
modulelink(self,
object)
Make a link for a module. |
|
|
|
modpkglink(self,
(name, path, ispackage, shadowed))
Make a link for a module or package to display in an index. |
|
|
|
markup(self,
text,
escape=None,
funcs={ } ,
classes={ } ,
methods={ } )
Mark up some plain text, given a context of symbols to look for. |
|
|
|
formattree(self,
tree,
modname,
parent=None)
Produce HTML for a class tree as given by inspect.getclasstree(). |
|
|
|
docmodule(self,
object,
name=None,
mod=None,
*ignored)
Produce HTML documentation for a module object. |
|
|
|
docclass(self,
object,
name=None,
mod=None,
funcs={ } ,
classes={ } ,
*ignored)
Produce HTML documentation for a class object. |
|
|
|
formatvalue(self,
object)
Format an argument default value as text. |
|
|
|
docroutine(self,
object,
name=None,
mod=None,
funcs={ } ,
classes={ } ,
methods={ } ,
cl=None)
Produce HTML documentation for a function or method object. |
|
|
|
_docdescriptor(self,
name,
value,
mod) |
|
|
|
docproperty(self,
object,
name=None,
mod=None,
cl=None)
Produce html documentation for a property. |
|
|
|
docother(self,
object,
name=None,
mod=None,
*ignored)
Produce HTML documentation for a data object. |
|
|
|
docdata(self,
object,
name=None,
mod=None,
cl=None)
Produce html documentation for a data descriptor. |
|
|
|
index(self,
dir,
shadowed=None)
Generate an HTML index for a directory of modules. |
|
|
Inherited from Doc :
document ,
fail ,
getdocloc
|