Module utils

Misc. utility functions/classes for admin documentation generator.

Functions

trim_docstring(docstring)
Uniformly trims leading/trailing whitespace from docstrings.

source code

parse_docstring(docstring)
Parse out the parts of a docstring.

source code

parse_rst(text, default_reference_context, thing_being_parsed=None, link_base='../..')
Convert the string from reST to an XHTML fragment.

source code

create_reference_role(rolename, urlbase)

source code

default_reference_role(name, rawtext, text, lineno, inliner, options=None, content=None)

source code

Variables

docutils_is_available = True

ROLES = {'model': '%s/models/%s/', 'view': '%s/views/%s/', 'te...

Imports: re, HeaderParser, HeaderParseError, mark_safe, docutils

Function Details

Uniformly trims leading/trailing whitespace from docstrings.

Based on http://www.python.org/peps/pep-0257.html#handling-docstring-indentation

Parse out the parts of a docstring. Returns (title, body, metadata).

Variables Details

Value:

{'model': '%s/models/%s/', 'view': '%s/views/%s/', 'template': '%s/tem
plates/%s/', 'filter': '%s/filters/#%s', 'tag': '%s/tags/#%s',}