summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorŁukasz Langa <lukasz@langa.pl>2013-05-18 17:43:21 +0200
committerŁukasz Langa <lukasz@langa.pl>2013-05-19 13:18:35 +0200
commit660762681cfbd8cabce0b6c83fae5b3b60c0d60c (patch)
tree4c4a6a1c0dda165cd69ee12bdb37da3bd73b286a /docs
parenta7e2835276b212425dc07251c833b406304ab1a4 (diff)
Fixed #20126 -- XViewMiddleware moved to django.contrib.admindocs.middleware
Diffstat (limited to 'docs')
-rw-r--r--docs/ref/contrib/admin/admindocs.txt10
-rw-r--r--docs/ref/middleware.txt13
-rw-r--r--docs/ref/settings.txt2
-rw-r--r--docs/releases/1.6.txt4
4 files changed, 10 insertions, 19 deletions
diff --git a/docs/ref/contrib/admin/admindocs.txt b/docs/ref/contrib/admin/admindocs.txt
index 394d078e5b..4af94bdcf6 100644
--- a/docs/ref/contrib/admin/admindocs.txt
+++ b/docs/ref/contrib/admin/admindocs.txt
@@ -31,7 +31,7 @@ the following:
* **Optional:** Linking to templates requires the :setting:`ADMIN_FOR`
setting to be configured.
* **Optional:** Using the admindocs bookmarklets requires the
- :mod:`XViewMiddleware<django.middleware.doc>` to be installed.
+ :mod:`XViewMiddleware<django.contrib.admindocs.middleware>` to be installed.
Once those steps are complete, you can start browsing the documentation by
going to your admin interface and clicking the "Documentation" link in the
@@ -156,7 +156,7 @@ Edit this object
Using these bookmarklets requires that you are either logged into the
:mod:`Django admin <django.contrib.admin>` as a
:class:`~django.contrib.auth.models.User` with
-:attr:`~django.contrib.auth.models.User.is_staff` set to `True`, or
-that the :mod:`django.middleware.doc` middleware and
-:mod:`XViewMiddleware <django.middleware.doc>` are installed and you
-are accessing the site from an IP address listed in :setting:`INTERNAL_IPS`.
+:attr:`~django.contrib.auth.models.User.is_staff` set to `True`, or that the
+:mod:`XViewMiddleware <django.contrib.admindocs.middleware>` is installed and
+you are accessing the site from an IP address listed in
+:setting:`INTERNAL_IPS`.
diff --git a/docs/ref/middleware.txt b/docs/ref/middleware.txt
index 03885a2215..4898bab636 100644
--- a/docs/ref/middleware.txt
+++ b/docs/ref/middleware.txt
@@ -71,19 +71,6 @@ Adds a few conveniences for perfectionists:
* Sends broken link notification emails to :setting:`MANAGERS` (see
:doc:`/howto/error-reporting`).
-View metadata middleware
-------------------------
-
-.. module:: django.middleware.doc
- :synopsis: Middleware to help your app self-document.
-
-.. class:: XViewMiddleware
-
-Sends custom ``X-View`` HTTP headers to HEAD requests that come from IP
-addresses defined in the :setting:`INTERNAL_IPS` setting. This is used by
-Django's :doc:`automatic documentation system </ref/contrib/admin/admindocs>`.
-Depends on :class:`~django.contrib.auth.middleware.AuthenticationMiddleware`.
-
GZip middleware
---------------
diff --git a/docs/ref/settings.txt b/docs/ref/settings.txt
index 8ef59064f7..c1170e19c5 100644
--- a/docs/ref/settings.txt
+++ b/docs/ref/settings.txt
@@ -1243,7 +1243,7 @@ Default: ``()`` (Empty tuple)
A tuple of IP addresses, as strings, that:
* See debug comments, when :setting:`DEBUG` is ``True``
-* Receive X headers if the ``XViewMiddleware`` is installed (see
+* Receive X headers in admindocs if the ``XViewMiddleware`` is installed (see
:doc:`/topics/http/middleware`)
.. setting:: LANGUAGE_CODE
diff --git a/docs/releases/1.6.txt b/docs/releases/1.6.txt
index b4668c38d0..6643fb7d32 100644
--- a/docs/releases/1.6.txt
+++ b/docs/releases/1.6.txt
@@ -502,6 +502,10 @@ Miscellaneous
ineffective so it has been removed, along with its generic implementation,
previously available in ``django.core.xheaders``.
+* The ``XViewMiddleware`` has been moved from ``django.middleware.doc`` to
+ ``django.contrib.admindocs.middleware`` because it is an implementation
+ detail of admindocs, proven not to be reusable in general.
+
Features deprecated in 1.6
==========================