From fd0f6308c840ab5d5712d4b51e47d51bc2809167 Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Fri, 3 Jul 2009 14:06:56 +0000 Subject: API docs audit. --- docs/api/chameleon_text.rst | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 docs/api/chameleon_text.rst (limited to 'docs/api/chameleon_text.rst') diff --git a/docs/api/chameleon_text.rst b/docs/api/chameleon_text.rst new file mode 100644 index 000000000..f56caeda9 --- /dev/null +++ b/docs/api/chameleon_text.rst @@ -0,0 +1,30 @@ +.. _chameleon_text_module: + +:mod:`repoze.bfg.chameleon_text` +---------------------------------- + +.. automodule:: repoze.bfg.chameleon_text + + .. autofunction:: get_template + + .. autofunction:: render_template + + .. autofunction:: render_template_to_response + +These APIs will will work against template files which contain simple +``${Genshi}`` - style replacement markers. + +The API of :mod:`repoze.bfg.chameleon_text` is identical to that of +:mod:`repoze.bfg.chameleon_zpt`; only its import location is +different. If you need to import an API functions from this module as +well as the :mod:`repoze.bfg.chameleon_zpt` module within the same +view file, use the ``as`` feature of the Python import statement, +e.g.: + +.. code-block:: python + + from repoze.chameleon_zpt import render_template as zpt_render + from repoze.chameleon_text import render_template as text_render + + + -- cgit v1.2.3