diff options
Diffstat (limited to 'docs/api')
| -rw-r--r-- | docs/api/chameleon_text.rst | 30 | ||||
| -rw-r--r-- | docs/api/chameleon_zpt.rst | 27 | ||||
| -rw-r--r-- | docs/api/interfaces.rst | 22 | ||||
| -rw-r--r-- | docs/api/router.rst | 4 | ||||
| -rw-r--r-- | docs/api/template.rst | 57 |
5 files changed, 58 insertions, 82 deletions
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 + + + 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 diff --git a/docs/api/interfaces.rst b/docs/api/interfaces.rst deleted file mode 100644 index e174966a4..000000000 --- a/docs/api/interfaces.rst +++ /dev/null @@ -1,22 +0,0 @@ -.. _interfaces_module: - -:mod:`repoze.bfg.interfaces` -============================ - -Request-related interfaces ---------------------------- - -.. automodule:: repoze.bfg.interfaces - - .. autoclass:: IRequest - - .. autoclass:: IGETRequest - - .. autoclass:: IPOSTRequest - - .. autoclass:: IPUTRequest - - .. autoclass:: IDELETERequest - - .. autoclass:: IHEADRequest - diff --git a/docs/api/router.rst b/docs/api/router.rst index 84d51f73a..11e5b6b35 100644 --- a/docs/api/router.rst +++ b/docs/api/router.rst @@ -5,6 +5,4 @@ .. automodule:: repoze.bfg.router -.. autoclass:: Router - -.. autofunction:: repoze.bfg.router.make_app +.. autofunction:: repoze.bfg.router.make_app(root_factory, package=None, filename='configure.zcml') diff --git a/docs/api/template.rst b/docs/api/template.rst deleted file mode 100644 index 763dc9dfe..000000000 --- a/docs/api/template.rst +++ /dev/null @@ -1,57 +0,0 @@ -.. _template_module: - -:mod:`repoze.bfg` Built-in Templating Facilties -=============================================== - -Two templating facilities are provided by :mod:`repoze.bfg` "out of -the box": :term:`ZPT` -style and text templating. - -ZPT-style and text templates are in :mod:`repoze.bfg` are supported by -the :term:`Chameleon` (nee :term:`z3c.pt`) templating engine, which -contains an alternate implementation of the ZPT language -specification. - -Below is API documentation for each of those facilities. Each -facility is similar to the other, but to use a particular facility, -you must import the API function from a specific module. For -instance, to render a ZPT-style template to a response, you would -import the ``render_template_to_response`` function from -``repoze.bfg.chameleon_zpt`` while you would import -``render_template_to_response`` from ``repoze.bfg.chameleon_text`` in -order to render a text-style template to a response. While these -functions have the same name, each will only operate on template files -that match the style in which the template file itself is written. If -you need to import API functions from two templating facilities within -the same module, 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 - -:mod:`repoze.bfg.chameleon_zpt` -------------------------------- - -.. automodule:: repoze.bfg.chameleon_zpt - - .. autofunction:: get_template - - .. autofunction:: render_template - - .. autofunction:: render_template_to_response - -.. note:: For backwards compatibility purposes, these functions may - also be imported from ``repoze.bfg.template``. - -:mod:`repoze.bfg.chameleon_text` ----------------------------------- - -.. automodule:: repoze.bfg.chameleon_text - - .. autofunction:: get_template - - .. autofunction:: render_template - - .. autofunction:: render_template_to_response - |