Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

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
  • Loading branch information...
commit 00678334aa7fb96d2f5fca3704e61e23317217a7 1 parent d1d6109
Carl Meyer authored September 16, 2011
5  docs/howto/custom-model-fields.txt
@@ -177,6 +177,7 @@ below), but we ensure it has a fixed length, since it only needs to hold 52
177 177
 card values plus their suits; 104 characters in total.
178 178
 
179 179
 .. note::
  180
+
180 181
     Many of Django's model fields accept options that they don't do anything
181 182
     with. For example, you can pass both
182 183
     :attr:`~django.db.models.Field.editable` and
@@ -189,8 +190,8 @@ card values plus their suits; 104 characters in total.
189 190
     This behavior simplifies the field classes, because they don't need to
190 191
     check for options that aren't necessary. They just pass all the options to
191 192
     the parent class and then don't use them later on. It's up to you whether
192  
-    you want your fields to be more strict about the options they select, or
193  
-    to use the simpler, more permissive behavior of the current fields.
  193
+    you want your fields to be more strict about the options they select, or to
  194
+    use the simpler, more permissive behavior of the current fields.
194 195
 
195 196
 .. method:: Field.__init__
196 197
 
9  docs/ref/contrib/admin/index.txt
@@ -1895,12 +1895,13 @@ a new view to your admin site, extend the base
1895 1895
 a pattern for your new view.
1896 1896
 
1897 1897
 .. note::
  1898
+
1898 1899
     Any view you render that uses the admin templates, or extends the base
1899 1900
     admin template, should provide the ``current_app`` argument to
1900  
-    :class:`~django.template.RequestContext` or :class:`~django.template.Context`
1901  
-    when rendering the template.  It should be set to either ``self.name`` if
1902  
-    your view is on an ``AdminSite`` or ``self.admin_site.name`` if your view
1903  
-    is on a ``ModelAdmin``.
  1901
+    :class:`~django.template.RequestContext` or
  1902
+    :class:`~django.template.Context` when rendering the template.  It should
  1903
+    be set to either ``self.name`` if your view is on an ``AdminSite`` or
  1904
+    ``self.admin_site.name`` if your view is on a ``ModelAdmin``.
1904 1905
 
1905 1906
 .. _admin-reverse-urls:
1906 1907
 
18  docs/ref/settings.txt
@@ -1765,11 +1765,13 @@ If the :doc:`staticfiles</ref/contrib/staticfiles>` contrib app is enabled
1765 1765
 files into this directory. See the howto on :doc:`managing static
1766 1766
 files</howto/static-files>` for more details about usage.
1767 1767
 
1768  
-.. warning:: This should be an (initially empty) destination directory for
1769  
-    collecting your static files from their permanent locations into one
1770  
-    directory for ease of deployment; it is **not** a place to store your
1771  
-    static files permanently. You should do that in directories that will be
1772  
-    found by :doc:`staticfiles</ref/contrib/staticfiles>`'s
  1768
+.. warning::
  1769
+
  1770
+    This should be an (initially empty) destination directory for collecting
  1771
+    your static files from their permanent locations into one directory for
  1772
+    ease of deployment; it is **not** a place to store your static files
  1773
+    permanently. You should do that in directories that will be found by
  1774
+    :doc:`staticfiles</ref/contrib/staticfiles>`'s
1773 1775
     :setting:`finders<STATICFILES_FINDERS>`, which by default, are
1774 1776
     ``'static/'`` app sub-directories and any directories you include in
1775 1777
     :setting:`STATICFILES_DIRS`).
@@ -2059,9 +2061,9 @@ format of the current locale.
2059 2061
 See also :setting:`USE_I18N` and :setting:`LANGUAGE_CODE`
2060 2062
 
2061 2063
 .. note::
2062  
-    The default :file:`settings.py` file created by
2063  
-    :djadmin:`django-admin.py startproject <startproject>` includes
2064  
-    ``USE_L10N = True`` for convenience.
  2064
+
  2065
+    The default :file:`settings.py` file created by :djadmin:`django-admin.py
  2066
+    startproject <startproject>` includes ``USE_L10N = True`` for convenience.
2065 2067
 
2066 2068
 .. setting:: USE_THOUSAND_SEPARATOR
2067 2069
 
18  docs/ref/templates/api.txt
@@ -404,11 +404,12 @@ optional, third positional argument, ``processors``. In this example, the
404 404
         return HttpResponse(t.render(c))
405 405
 
406 406
 .. note::
  407
+
407 408
     If you're using Django's :func:`~django.shortcuts.render_to_response()`
408 409
     shortcut to populate a template with the contents of a dictionary, your
409 410
     template will be passed a ``Context`` instance by default (not a
410  
-    ``RequestContext``). To use a ``RequestContext`` in your template rendering,
411  
-    pass an optional third argument to
  411
+    ``RequestContext``). To use a ``RequestContext`` in your template
  412
+    rendering, pass an optional third argument to
412 413
     :func:`~django.shortcuts.render_to_response()`: a ``RequestContext``
413 414
     instance. Your code might look like this::
414 415
 
@@ -704,12 +705,13 @@ class. Here are the template loaders that come with Django:
704 705
         )
705 706
 
706 707
     .. note::
707  
-        All of the built-in Django template tags are safe to use with the cached
708  
-        loader, but if you're using custom template tags that come from third
709  
-        party packages, or that you wrote yourself, you should ensure that the
710  
-        ``Node`` implementation for each tag is thread-safe. For more
711  
-        information, see
712  
-        :ref:`template tag thread safety considerations<template_tag_thread_safety>`.
  708
+
  709
+        All of the built-in Django template tags are safe to use with the
  710
+        cached loader, but if you're using custom template tags that come from
  711
+        third party packages, or that you wrote yourself, you should ensure
  712
+        that the ``Node`` implementation for each tag is thread-safe. For more
  713
+        information, see :ref:`template tag thread safety
  714
+        considerations<template_tag_thread_safety>`.
713 715
 
714 716
     This loader is disabled by default.
715 717
 
14  docs/topics/http/middleware.txt
@@ -98,13 +98,13 @@ view; it'll return that :class:`~django.http.HttpResponse`. Response
98 98
 middleware is always called on every response.
99 99
 
100 100
 .. note::
101  
-    Accessing :attr:`request.POST <django.http.HttpRequest.POST>` or 
102  
-    :attr:`request.REQUEST <django.http.HttpRequest.REQUEST>` inside 
103  
-    middleware from ``process_request`` or ``process_view`` will prevent any
104  
-    view running after the middleware from being able to
105  
-    :ref:`modify the upload handlers for the 
106  
-    request <modifying_upload_handlers_on_the_fly>`, and should normally be
107  
-    avoided.
  101
+
  102
+    Accessing :attr:`request.POST <django.http.HttpRequest.POST>` or
  103
+    :attr:`request.REQUEST <django.http.HttpRequest.REQUEST>` inside middleware
  104
+    from ``process_request`` or ``process_view`` will prevent any view running
  105
+    after the middleware from being able to :ref:`modify the upload handlers
  106
+    for the request <modifying_upload_handlers_on_the_fly>`, and should
  107
+    normally be avoided.
108 108
 
109 109
     The :class:`~django.middleware.csrf.CsrfViewMiddleware` class can be
110 110
     considered an exception, as it provides the
7  docs/topics/i18n/localization.txt
@@ -260,9 +260,10 @@ Django's formatting system is disabled by default. To enable it, it's
260 260
 necessary to set :setting:`USE_L10N = True <USE_L10N>` in your settings file.
261 261
 
262 262
 .. note::
263  
-    The default :file:`settings.py` file created by
264  
-    :djadmin:`django-admin.py startproject <startproject>` includes
265  
-    :setting:`USE_L10N = True <USE_L10N>` for convenience.
  263
+
  264
+    The default :file:`settings.py` file created by :djadmin:`django-admin.py
  265
+    startproject <startproject>` includes :setting:`USE_L10N = True <USE_L10N>`
  266
+    for convenience.
266 267
 
267 268
 When using Django's formatting system, dates and numbers on templates will be
268 269
 displayed using the format specified for the current locale. Two users

0 notes on commit 0067833

Please sign in to comment.
Something went wrong with that request. Please try again.