lesscode.org

rst

Restructured Text Support Module

The rst module is accessible via the pudge module.

This module is used internally to transform docstrings and Restructured Text documents to HTML.

Attributes

a __url__

'$URL: svn://lesscode.org/pudge/trunk/pudge/rst.py $'

Functions

f parts(file) ...

Parse file and return a dictionary containing transformed parts.

This uses the docutils.core.publish_parts function internally. Interesting parts include the following:

fragment
The body without the header, title, or footer.
title
The document title.

f to_html(text) ...

Convert text to HTML and return result as a unicode string.

f trim(docstring) ...

Trim a docstring.

Taken from the example given in PEP 257.

See the source for more information.