diff options
author | Mike Bayer <mike_mp@zzzcomputing.com> | 2015-01-22 15:59:03 -0500 |
---|---|---|
committer | Mike Bayer <mike_mp@zzzcomputing.com> | 2015-01-22 15:59:03 -0500 |
commit | e3cef89aeef125e92144f7949e89042bf7b311be (patch) | |
tree | fadfd0ee1ee046792731d72c6b8b40586ebe3d88 /doc/build/caching.rst | |
parent | b253e62fc03c964006294298184fffdfbd13bfe8 (diff) | |
download | mako-e3cef89aeef125e92144f7949e89042bf7b311be.tar.gz |
- reorganize cache tests so that we have distinct series for beaker,
dogpile, "generic"
- stress dogpile a bit more in caching docs
Diffstat (limited to 'doc/build/caching.rst')
-rw-r--r-- | doc/build/caching.rst | 36 |
1 files changed, 15 insertions, 21 deletions
diff --git a/doc/build/caching.rst b/doc/build/caching.rst index 2a494ed..bfe4f41 100644 --- a/doc/build/caching.rst +++ b/doc/build/caching.rst @@ -20,9 +20,15 @@ method will return content directly from the cache. When the :class:`.Template` object itself falls out of scope, its corresponding cache is garbage collected along with the template. -By default, caching requires that the `Beaker <http://beaker.readthedocs.org/>`_ package be installed on the -system, however the mechanism of caching can be customized to use -any third party or user defined system -- see :ref:`cache_plugins`. +The caching system requires that a cache backend be installed; this +includes either the `Beaker <http://beaker.readthedocs.org/>`_ package +or the `dogpile.cache <http://dogpilecache.readthedocs.org>`_, as well as +any other third-party caching libraries that feature Mako integration. + +By default, caching will attempt to make use of Beaker. +To use dogpile.cache, the +``cache_impl`` argument must be set; see this argument in the +section :ref:`cache_arguments`. In addition to being available on the ``<%page>`` tag, the caching flag and all its options can be used with the ``<%def>`` tag as well: @@ -41,6 +47,9 @@ its options can be used with the ``<%def>`` tag as well: other text </%block> + +.. _cache_arguments: + Cache Arguments =============== @@ -88,28 +97,13 @@ caching can be configured using these arguments: ) * ``cache_impl`` - The string name of the cache backend - to use. This defaults to ``'beaker'``, which has historically - been the only cache backend supported by Mako. - - .. versionadded:: 0.6.0 - - For example, here's how to use the upcoming - `dogpile.cache <http://dogpilecache.readthedocs.org>`_ - backend: - - .. sourcecode:: python - - lookup = TemplateLookup( - directories='/path/to/templates', - cache_impl = 'dogpile.cache', - cache_args = {'regions':my_dogpile_regions} - ) + to use. This defaults to ``'beaker'``, indicating + that the 'beaker' backend will be used. * ``cache_args`` - A dictionary of cache parameters that will be consumed by the cache backend. See - :ref:`beaker_backend` for examples. + :ref:`beaker_backend` and :ref:`dogpile.cache_backend` for examples. - .. versionadded:: 0.6.0 Backend-Specific Cache Arguments -------------------------------- |