summaryrefslogtreecommitdiff
path: root/docs/narr/environment.rst
diff options
context:
space:
mode:
authorBen Bangert <ben@groovie.org>2010-10-30 15:26:56 -0700
committerBen Bangert <ben@groovie.org>2010-10-30 15:26:56 -0700
commit7d01c60c6190ca5edba9710e09799280a059efae (patch)
tree3f2aa9925023f28460f43d38e1547c4e3217c500 /docs/narr/environment.rst
parent66fcbf652e68b6b0865fc211570a71350c9276b3 (diff)
downloadpyramid-7d01c60c6190ca5edba9710e09799280a059efae.tar.gz
pyramid-7d01c60c6190ca5edba9710e09799280a059efae.tar.bz2
pyramid-7d01c60c6190ca5edba9710e09799280a059efae.zip
Adding Mako environment variables.
Diffstat (limited to 'docs/narr/environment.rst')
-rw-r--r--docs/narr/environment.rst61
1 files changed, 61 insertions, 0 deletions
diff --git a/docs/narr/environment.rst b/docs/narr/environment.rst
index 3b1f3d44f..fa639cce1 100644
--- a/docs/narr/environment.rst
+++ b/docs/narr/environment.rst
@@ -140,6 +140,67 @@ The value supplied here is used as the default locale name when a
| | |
+---------------------------------+-----------------------------+
+.. _mako_template_renderer_settings:
+
+Mako Template Render Settings
+-----------------------------
+
+Mako derives additional settings to configure its template renderer that
+should be set when using it. Many of these settings are optional and only need
+to be set if they should be different from the default. The Mako Template
+Renderer uses a subclass of Mako's `template lookup
+<http://www.makotemplates.org/docs/usage.html#usage_lookup>`_ and accepts
+several arguments to configure it.
+
+Mako Directories
+++++++++++++++++
+
+The value(s) supplied here are passed in as the template directories. They
+should be in :term:`resource specification` format, for example:
+``my.package:templates``.
+
++-----------------------------+
+| Config File Setting Name |
++=============================+
+| ``mako.directories`` |
+| |
+| |
+| |
++-----------------------------+
+
+Mako Module Directory
++++++++++++++++++++++
+
+The value supplied here tells Mako where to store compiled Mako templates. If
+omitted, compiled templates will be stored in memory. This value should be an
+absolute path, for example: ``%(here)s/data/templates`` would use a directory
+called ``data/templates`` in the same parent directory as the INI file.
+
++-----------------------------+
+| Config File Setting Name |
++=============================+
+| ``mako.module_directory`` |
+| |
+| |
+| |
++-----------------------------+
+
+Mako Input Encoding
++++++++++++++++++++
+
+The encoding that Mako templates are assumed to have. By default this is set
+to ``utf-8``. If you wish to use a different template encoding, this value
+should be changed accordingly.
+
++-----------------------------+
+| Config File Setting Name |
++=============================+
+| ``mako.input_encoding``__ |
+| |
+| |
+| |
++-----------------------------+
+
Examples
--------