Michael Merickel
2014-07-16 5098b81dcb03624a13c8c7098382bddbb486fee5
remove mako docs that should be in pyramid_mako package
1 files modified
148 ■■■■■ changed files
docs/narr/environment.rst 148 ●●●●● patch | view | raw | blame | history
docs/narr/environment.rst
@@ -13,7 +13,6 @@
   single: reload settings
   single: default_locale_name
   single: environment variables
   single: Mako environment settings
   single: ini file settings
   single: PasteDeploy settings
@@ -395,153 +394,6 @@
       config = Configurator(settings=settings)
It is fine to use both or either form.
.. _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:`asset 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``    |
|                             |
|                             |
|                             |
+-----------------------------+
Mako Error Handler
~~~~~~~~~~~~~~~~~~
A callable (or a :term:`dotted Python name` which names a callable) which is
called whenever Mako compile or runtime exceptions occur. The callable is
passed the current context as well as the exception. If the callable returns
True, the exception is considered to be handled, else it is re-raised after
the function completes. Is used to provide custom error-rendering functions.
+-----------------------------+
| Config File Setting Name    |
+=============================+
|  ``mako.error_handler``     |
|                             |
|                             |
|                             |
+-----------------------------+
Mako Default Filters
~~~~~~~~~~~~~~~~~~~~
List of string filter names that will be applied to all Mako expressions.
+-----------------------------+
| Config File Setting Name    |
+=============================+
|  ``mako.default_filters``   |
|                             |
|                             |
|                             |
+-----------------------------+
Mako Import
~~~~~~~~~~~
String list of Python statements, typically individual "import" lines, which
will be placed into the module level preamble of all generated Python modules.
+-----------------------------+
| Config File Setting Name    |
+=============================+
|  ``mako.imports``           |
|                             |
|                             |
|                             |
+-----------------------------+
Mako Strict Undefined
~~~~~~~~~~~~~~~~~~~~~
``true`` or ``false``, representing the "strict undefined" behavior of Mako
(see `Mako Context Variables
<http://www.makotemplates.org/docs/runtime.html#context-variables>`_).  By
default, this is ``false``.
+-----------------------------+
| Config File Setting Name    |
+=============================+
|  ``mako.strict_undefined``  |
|                             |
|                             |
|                             |
+-----------------------------+
Mako Preprocessor
~~~~~~~~~~~~~~~~~
.. versionadded:: 1.1
A callable (or a :term:`dotted Python name` which names a callable) which is
called to preprocess the source before the template is called.  The callable
will be passed the full template source before it is parsed. The return
result of the callable will be used as the template source code.
+-----------------------------+
| Config File Setting Name    |
+=============================+
|  ``mako.preprocessor``      |
|                             |
|                             |
|                             |
+-----------------------------+
Examples
--------