Module enthought.block_canvas.function_tools.rest

API Reference for Enthought Tool Suite 3.2.0

Classes and functions for converting reST docstrings to HTML

Variables

HTMLFragmentTranslator - A subclass of HTMLTranslator which produces only fragments of HTML

convert_function_info(function_name, doc_string, defaults = [ ])

Given a documentation string, writes html documentation. First tries to identify the standard docstring format for has_units objects. If sucessful, outputs a nicely formatted html. Otherwise, converts to html with no other changes.

Code borrowed from numerical_modelling's has_unit.py
convert_string(string)

Converts a string of reST text into html.
convert_string_fragment(string)

Converts a string of reST text into an html fragment (ie no <header>, <body>, etc tags).
get_html_from_function_info(function_info)

Convenience function to get html from a FunctionInfo object
pre_formatted_html(text)

Render the given text inside <pre> tags.

Local name	Refers to
cgi	cgi
core	docutils.core
HTMLTranslator	docutils.writers.html4css1.HTMLTranslator
logging	logging
new_document	docutils.utils.new_document
OptionParser	docutils.frontend.OptionParser
Parser	docutils.parsers.rst.Parser
platform	platform
textwrap	textwrap
Writer	docutils.writers.html4css1.Writer
wx	wx