summaryrefslogtreecommitdiff
path: root/docs/ref
diff options
context:
space:
mode:
authorBerker Peksag <berker.peksag@gmail.com>2013-09-16 00:51:24 +0300
committerTim Graham <timograham@gmail.com>2013-09-18 07:37:08 -0400
commit2f0566fa61e13277364e3aef338fa5c143f5a704 (patch)
tree207438ec3b7983be24dc972890dda923a9f4ee45 /docs/ref
parent893198509e3b821a56a56e4326929e0613aad983 (diff)
Fixed #4278 -- Added a dirs parameter to a few functions to override TEMPLATE_DIRS.
* django.template.loader.get_template() * django.template.loader.select_template() * django.shortcuts.render() * django.shortcuts.render_to_response() Thanks amcnabb for the suggestion.
Diffstat (limited to 'docs/ref')
-rw-r--r--docs/ref/templates/api.txt18
1 files changed, 16 insertions, 2 deletions
diff --git a/docs/ref/templates/api.txt b/docs/ref/templates/api.txt
index b0fc94040a..b3e49b6773 100644
--- a/docs/ref/templates/api.txt
+++ b/docs/ref/templates/api.txt
@@ -594,17 +594,31 @@ The Python API
``django.template.loader`` has two functions to load templates from files:
-.. function:: get_template(template_name)
+.. function:: get_template(template_name[, dirs])
``get_template`` returns the compiled template (a ``Template`` object) for
the template with the given name. If the template doesn't exist, it raises
``django.template.TemplateDoesNotExist``.
-.. function:: select_template(template_name_list)
+ To override the :setting:`TEMPLATE_DIRS` setting, use the ``dirs``
+ parameter. The ``dirs`` parameter may be a tuple or list.
+
+ .. versionchanged:: 1.7
+
+ The ``dirs`` parameter was added.
+
+.. function:: select_template(template_name_list[, dirs])
``select_template`` is just like ``get_template``, except it takes a list
of template names. Of the list, it returns the first template that exists.
+ To override the :setting:`TEMPLATE_DIRS` setting, use the ``dirs``
+ parameter. The ``dirs`` parameter may be a tuple or list.
+
+ .. versionchanged:: 1.7
+
+ The ``dirs`` parameter was added.
+
For example, if you call ``get_template('story_detail.html')`` and have the
above :setting:`TEMPLATE_DIRS` setting, here are the files Django will look for,
in order: