summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorSteve Piercy <web@stevepiercy.com>2013-10-07 19:51:33 -0700
committerSteve Piercy <web@stevepiercy.com>2013-10-07 19:51:33 -0700
commitcba6a8d33f674a1f873851a80358972184544d71 (patch)
treea7c0a6d3858937bcd7094629a30a5b85afeb5e3c /docs
parente893a0ecc0bc9929fcda1103b510991954dbdc6e (diff)
parent56170f30f6cd1d4268d9e5b0cd24a75c645ab0ca (diff)
downloadpyramid-cba6a8d33f674a1f873851a80358972184544d71.tar.gz
pyramid-cba6a8d33f674a1f873851a80358972184544d71.tar.bz2
pyramid-cba6a8d33f674a1f873851a80358972184544d71.zip
Merge branch 'doc_reload_template_note' of github.com:kpinc/pyramid into kpinc-doc_reload_template_note
Diffstat (limited to 'docs')
-rw-r--r--docs/narr/project.rst19
1 files changed, 10 insertions, 9 deletions
diff --git a/docs/narr/project.rst b/docs/narr/project.rst
index 9451f41b1..0de46c806 100644
--- a/docs/narr/project.rst
+++ b/docs/narr/project.rst
@@ -886,15 +886,16 @@ returns the HTML in a :term:`response`.
See :ref:`views_which_use_a_renderer` for more information about how views,
renderers, and templates relate and cooperate.
-.. note:: Because our ``development.ini`` has a ``pyramid.reload_templates =
- true`` directive indicating that templates should be reloaded when
- they change, you won't need to restart the application server to
- see changes you make to templates. During development, this is
- handy. If this directive had been ``false`` (or if the directive
- did not exist), you would need to restart the application server
- for each template change. For production applications, you should
- set your project's ``pyramid.reload_templates`` to ``false`` to increase
- the speed at which templates may be rendered.
+.. note:: ``development.ini`` has a setting that controls how templates are
+ reloaded: ``pyramid.reload_templates``.
+
+ - A setting of ``True`` (as in the scaffold ``development.ini``)
+ automatically reloads changed templates without a server restart. This
+ is convenient while developing but slows template rendering speed.
+
+ - A setting of ``False`` (the default) requires a server restart to
+ integrate template changes. Production applications should set
+ ``pyramid.reload_templates = False``.
.. index::
single: static directory