API docs audit.

1 files changed, 27 insertions, 0 deletions

diff --git a/docs/api/chameleon_zpt.rst b/docs/api/chameleon_zpt.rst
new file mode 100644
index 000000000..cd5f0ac65
--- /dev/null
+++ b/docs/api/chameleon_zpt.rst
@@ -0,0 +1,27 @@
+.. _chameleon_zpt_module:
+
+:mod:`repoze.bfg.chameleon_zpt`
+-------------------------------
+
+.. automodule:: repoze.bfg.chameleon_zpt
+
+  .. autofunction:: get_template
+
+  .. autofunction:: render_template
+
+  .. autofunction:: render_template_to_response
+
+These APIs will work against files which supply template text which
+matches the :term:`ZPT` specification.
+
+The API of :mod:`repoze.bfg.chameleon_zpt` is identical to that of
+:mod:`repoze.bfg.chameleon_text`; 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_text` 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