| | |
- classlink(object, modname, *dicts)
- no doc string
- defaultformat(object)
- no doc string
- document(object)
- Generate documentation for a given object.
- document_builtin(object)
- Produce HTML documentation for a given built-in function.
- document_class(object, functions={}, classes={})
- Produce HTML documentation for a given class object.
- document_function(object, functions={}, classes={}, methods={}, clname='')
- Produce HTML documentation for a given function object.
- document_method(object, functions={}, classes={}, methods={}, clname='')
- Produce HTML documentation for a given method object.
- document_module(object)
- Produce HTML documentation for a given module object.
- document_tree(tree, modname, classes={})
- Produce HTML for a class tree as returned by inspect.getclasstree().
- footer()
- no doc string
- getdoc(object)
- no doc string
- heading(title, fgcol, bgcol, extras='')
- no doc string
- htmlescape(str)
- # ---------------------------------------------------- formatting utilities
- htmlrepr(object)
- no doc string
- markup(text, functions={}, classes={}, methods={}, escape=<function htmlescape at 80e93c8>)
- Mark up some plain text, given a context of symbols to look for.
- Each context dictionary maps object names to named anchor identifiers.
- modulelink(object)
- no doc string
- multicolumn(list, format, cols=4)
- no doc string
- namelink(name, *dicts)
- no doc string
- preformat(str)
- no doc string
- section(title, fgcol, bgcol, contents, width=20, prelude='', marginalia=None, gap=' ')
- no doc string
- serialize(list)
- Combine a list containing strings and nested lists into a single
- string. This lets us manipulate lists until the last moment, since
- rearranging lists is faster than rearranging strings.
|