formatter_html

module documentation

Roughly components
Class MarkupSyntax Syntax type we assume comments are using
Function bigsection Format a section with a big heading.
Function disabled_text Wrap in grey
Function escape HTML safe repr and escape
Function file_link Make a link to source file.
Function heading Format a page heading.
Function html_repr Turn method into function
Function markup Replace all linkable things with links of appropriate syntax.
Function module_package_link Make a link for a module or package to display in an index.
Function multicolumn Format a list of items into a multi-column list.
Function namelink Make a link for an identifier, given name-to-URL mappings.
Function preformat Format literal preformatted text.
Function section Format a section with a heading.
Variable LOGGER Undocumented
Variable STDLIB_BASEDIR Formatter class for HTML documentation.
def bigsection(title, fgcol, bgcol, contents, width=6, prelude='', marginalia='', gap=' '):
Format a section with a big heading.
Parameters
title:strUndocumented
fgcol:strUndocumented
bgcol:strUndocumented
contents:strUndocumented
width:intUndocumented
prelude:strUndocumented
marginalia:strUndocumented
gap:strUndocumented
Returns
strUndocumented
def disabled_text(text):
Wrap in grey
Parameters
text:strUndocumented
Returns
strUndocumented
def escape(value):
HTML safe repr and escape
Parameters
value:AnyUndocumented
Returns
strUndocumented
def file_link(url, path):
Make a link to source file.
Parameters
url:strUndocumented
path:strUndocumented
Returns
strUndocumented
def heading(title, fgcol, bgcol, extras=''):
Format a page heading.
Parameters
title:strUndocumented
fgcol:strUndocumented
bgcol:strUndocumented
extras:strUndocumented
Returns
strUndocumented
def html_repr(value):
Turn method into function
Parameters
value:AnyUndocumented
Returns
strUndocumented
def markup(text, funcs=None, classes=None, methods=None):

Replace all linkable things with links of appropriate syntax.

Handle either an adhoc markup language, or RST or Markdown. funcs, classes, methods are name/symbol to URL maps.

Parameters
text:strUndocumented
funcs:Optional[Dict[str, str]]Undocumented
classes:Optional[Dict[str, str]]Undocumented
methods:Optional[Dict[str, str]]Undocumented
Returns
strUndocumented
def module_package_link(module_package_info):
Make a link for a module or package to display in an index.
Parameters
module_package_info:Tuple[str, str, str, str]Undocumented
Returns
strUndocumented
def multicolumn(the_list, the_format, cols=4):
Format a list of items into a multi-column list.
Parameters
the_list:Union[Sequence[Tuple[Any, str, Any, int]], Sequence[Tuple[str, Any]]]Undocumented
the_format:Callable[[Any], str]Undocumented
cols:intUndocumented
Returns
strUndocumented
def namelink(name, *dicts):
Make a link for an identifier, given name-to-URL mappings.
Parameters
name:strUndocumented
dicts:Dict[str, str]Undocumented
Returns
strUndocumented
def preformat(text):
Format literal preformatted text.
Parameters
text:strUndocumented
Returns
strUndocumented
def section(title, fgcol, bgcol, contents, width=6, prelude='', marginalia='', gap=' '):
Format a section with a heading.
Parameters
title:strUndocumented
fgcol:strUndocumented
bgcol:strUndocumented
contents:strUndocumented
width:intUndocumented
prelude:strUndocumented
marginalia:strUndocumented
gap:strUndocumented
Returns
strUndocumented
LOGGER =

Undocumented

STDLIB_BASEDIR =
Formatter class for HTML documentation.