summaryrefslogtreecommitdiff
path: root/docs/ref
diff options
context:
space:
mode:
authorCarl Meyer <carl@oddbird.net>2011-09-16 18:06:42 +0000
committerCarl Meyer <carl@oddbird.net>2011-09-16 18:06:42 +0000
commit00678334aa7fb96d2f5fca3704e61e23317217a7 (patch)
tree80bdf76a8fdbf0681dce5d3829da7cadee44ca67 /docs/ref
parentd1d6109229b4c103da682d4aa8bcac930c07da0b (diff)
Fixed #16863 -- Corrected ReST markup to avoid errors building docs.
Although directives such as "note" and "warning" will accept content immediately following the directive, this is technically where arguments to the directive should go (see http://sphinx.pocoo.org/rest.html#directives). Putting the content there means that any lines beginning with an inline text role (e.g. ":setting:`DEBUG`") will be mis-interpreted as an option block for the directive. To avoid this error, there should always be a blank line between the directive start and the directive content. git-svn-id: http://code.djangoproject.com/svn/django/trunk@16842 bcc190cf-cafb-0310-a4f2-bffc1f526a37
Diffstat (limited to 'docs/ref')
-rw-r--r--docs/ref/contrib/admin/index.txt9
-rw-r--r--docs/ref/settings.txt18
-rw-r--r--docs/ref/templates/api.txt18
3 files changed, 25 insertions, 20 deletions
diff --git a/docs/ref/contrib/admin/index.txt b/docs/ref/contrib/admin/index.txt
index bdbe61505d..2da6774d44 100644
--- a/docs/ref/contrib/admin/index.txt
+++ b/docs/ref/contrib/admin/index.txt
@@ -1895,12 +1895,13 @@ a new view to your admin site, extend the base
a pattern for your new view.
.. note::
+
Any view you render that uses the admin templates, or extends the base
admin template, should provide the ``current_app`` argument to
- :class:`~django.template.RequestContext` or :class:`~django.template.Context`
- when rendering the template. It should be set to either ``self.name`` if
- your view is on an ``AdminSite`` or ``self.admin_site.name`` if your view
- is on a ``ModelAdmin``.
+ :class:`~django.template.RequestContext` or
+ :class:`~django.template.Context` when rendering the template. It should
+ be set to either ``self.name`` if your view is on an ``AdminSite`` or
+ ``self.admin_site.name`` if your view is on a ``ModelAdmin``.
.. _admin-reverse-urls:
diff --git a/docs/ref/settings.txt b/docs/ref/settings.txt
index 781c231354..69e939bec1 100644
--- a/docs/ref/settings.txt
+++ b/docs/ref/settings.txt
@@ -1765,11 +1765,13 @@ If the :doc:`staticfiles</ref/contrib/staticfiles>` contrib app is enabled
files into this directory. See the howto on :doc:`managing static
files</howto/static-files>` for more details about usage.
-.. warning:: This should be an (initially empty) destination directory for
- collecting your static files from their permanent locations into one
- directory for ease of deployment; it is **not** a place to store your
- static files permanently. You should do that in directories that will be
- found by :doc:`staticfiles</ref/contrib/staticfiles>`'s
+.. warning::
+
+ This should be an (initially empty) destination directory for collecting
+ your static files from their permanent locations into one directory for
+ ease of deployment; it is **not** a place to store your static files
+ permanently. You should do that in directories that will be found by
+ :doc:`staticfiles</ref/contrib/staticfiles>`'s
:setting:`finders<STATICFILES_FINDERS>`, which by default, are
``'static/'`` app sub-directories and any directories you include in
:setting:`STATICFILES_DIRS`).
@@ -2059,9 +2061,9 @@ format of the current locale.
See also :setting:`USE_I18N` and :setting:`LANGUAGE_CODE`
.. note::
- The default :file:`settings.py` file created by
- :djadmin:`django-admin.py startproject <startproject>` includes
- ``USE_L10N = True`` for convenience.
+
+ The default :file:`settings.py` file created by :djadmin:`django-admin.py
+ startproject <startproject>` includes ``USE_L10N = True`` for convenience.
.. setting:: USE_THOUSAND_SEPARATOR
diff --git a/docs/ref/templates/api.txt b/docs/ref/templates/api.txt
index c8100fc0f9..2cea3eb7da 100644
--- a/docs/ref/templates/api.txt
+++ b/docs/ref/templates/api.txt
@@ -404,11 +404,12 @@ optional, third positional argument, ``processors``. In this example, the
return HttpResponse(t.render(c))
.. note::
+
If you're using Django's :func:`~django.shortcuts.render_to_response()`
shortcut to populate a template with the contents of a dictionary, your
template will be passed a ``Context`` instance by default (not a
- ``RequestContext``). To use a ``RequestContext`` in your template rendering,
- pass an optional third argument to
+ ``RequestContext``). To use a ``RequestContext`` in your template
+ rendering, pass an optional third argument to
:func:`~django.shortcuts.render_to_response()`: a ``RequestContext``
instance. Your code might look like this::
@@ -704,12 +705,13 @@ class. Here are the template loaders that come with Django:
)
.. note::
- All of the built-in Django template tags are safe to use with the cached
- loader, but if you're using custom template tags that come from third
- party packages, or that you wrote yourself, you should ensure that the
- ``Node`` implementation for each tag is thread-safe. For more
- information, see
- :ref:`template tag thread safety considerations<template_tag_thread_safety>`.
+
+ All of the built-in Django template tags are safe to use with the
+ cached loader, but if you're using custom template tags that come from
+ third party packages, or that you wrote yourself, you should ensure
+ that the ``Node`` implementation for each tag is thread-safe. For more
+ information, see :ref:`template tag thread safety
+ considerations<template_tag_thread_safety>`.
This loader is disabled by default.