From 727b4e05f59c15904f7b08388220b7bfc76d59b2 Mon Sep 17 00:00:00 2001
From: Aymeric Augustin
Date: Fri, 25 Apr 2014 18:53:00 +0200
Subject: Make the pain go away.

Fix #581, #544, #541, #535 and a few others.
---
 docs/changes.rst       | 21 +++++++++++++++++++--
 docs/configuration.rst | 10 +++++++++-
 docs/panels.rst        |  3 ++-
 docs/tips.rst          |  7 +++----
 4 files changed, 33 insertions(+), 8 deletions(-)

(limited to 'docs')

diff --git a/docs/changes.rst b/docs/changes.rst
index 5020466..ca31fb9 100644
--- a/docs/changes.rst
+++ b/docs/changes.rst
@@ -1,6 +1,23 @@
 Change log
 ==========
 
+1.2
+---
+
+New features
+~~~~~~~~~~~~
+
+* The ``JQUERY_URL`` setting defines where the toolbar loads jQuery from.
+
+Bugfixes
+~~~~~~~~
+
+* The toolbar now always loads a private copy of jQuery in order to avoid
+  using an incompatible version. It no longer attemps to integrate with AMD.
+
+  This private copy is available in ``djdt.jQuery``. Third-party panels are
+  encouraged to use it because it should be as stable as the toolbar itself.
+
 1.1
 ---
 
@@ -24,8 +41,8 @@ Bugfixes
 Deprecated features
 ~~~~~~~~~~~~~~~~~~~
 
-* The `INTERCEPT_REDIRECT` setting is superseded by the more generic
-  `DISABLE_PANELS`.
+* The ``INTERCEPT_REDIRECTS`` setting is superseded by the more generic
+  ``DISABLE_PANELS``.
 
 1.0
 ---
diff --git a/docs/configuration.rst b/docs/configuration.rst
index ff4ece7..0905be5 100644
--- a/docs/configuration.rst
+++ b/docs/configuration.rst
@@ -71,6 +71,14 @@ Toolbar options
   The toolbar searches for this string in the HTML and inserts itself just
   before.
 
+* ``JQUERY_URL``
+
+  Default: ``'//ajax.googleapis.com/ajax/libs/jquery/2.1.0/jquery.min.js'``
+
+  URL of the copy of jQuery that will be used by the toolbar. Set it to a
+  locally-hosted version of jQuery for offline development. Make it empty to
+  rely on a version of jQuery that already exists on every page of your site.
+
 * ``RENDER_PANELS``
 
   Default: ``None``
@@ -113,7 +121,7 @@ Toolbar options
   This is the dotted path to a function used for determining whether the
   toolbar should show or not. The default checks are that ``DEBUG`` must be
   set to ``True``, the IP of the request must be in ``INTERNAL_IPS``, and the
-  request must no be an AJAX request. You can provide your own function 
+  request must no be an AJAX request. You can provide your own function
   ``callback(request)`` which returns ``True`` or ``False``.
 
 Panel options
diff --git a/docs/panels.rst b/docs/panels.rst
index 58713b4..8941ed2 100644
--- a/docs/panels.rst
+++ b/docs/panels.rst
@@ -240,7 +240,8 @@ according to the public API described below. Unless noted otherwise, all
 methods are optional.
 
 Panels can ship their own templates, static files and views. They're no public
-CSS or JavaScript API at this time, but they can assume jQuery is available.
+CSS or JavaScript API at this time, but they can assume jQuery is available in
+``djdt.jQuery``.
 
 .. autoclass:: debug_toolbar.panels.Panel(*args, **kwargs)
 
diff --git a/docs/tips.rst b/docs/tips.rst
index 5e3ea40..b65c3d6 100644
--- a/docs/tips.rst
+++ b/docs/tips.rst
@@ -16,14 +16,13 @@ flatpages.
 Using the toolbar offline
 -------------------------
 
-The Debug Toolbar depends on the jQuery_ library. If jQuery isn't already
-loaded in your page, the toolbar loads it from the Google Hosted Libraries
+The Debug Toolbar loads the jQuery_ library from the Google Hosted Libraries
 CDN. Your browser will keep it in cache, allowing you to use the toolbar even
 if you disconnect from the Internet temporarily.
 
 If you want to use the Debug Toolbar without an Internet connection at all, or
-if you refuse to depend on Google's services, you should include your own copy
-of jQuery on every page.
+if you refuse to depend on Google's services, look at the ``JQUERY_URL``
+configuration option.
 
 .. _jQuery: http://jquery.com/
 
-- 
cgit v1.2.3