aboutsummaryrefslogtreecommitdiffstats
path: root/docs/installation.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/installation.rst')
-rw-r--r--docs/installation.rst12
1 files changed, 12 insertions, 0 deletions
diff --git a/docs/installation.rst b/docs/installation.rst
index 221d85f..921cfe8 100644
--- a/docs/installation.rst
+++ b/docs/installation.rst
@@ -51,9 +51,21 @@ what it does, or if you prefer defining your settings explicitly, read below.
during the start-up sequence. This works with ``manage.py runserver``
because it validates models before serving requests.
+.. warning::
+
+ The automatic setup imports your project's URLconf in order to add the
+ Debug Toolbar's URLs. This may trigger circular imports when the URLconf
+ imports views that import models. If you're hitting an :exc:`ImportError`,
+ follow the explicit setup instructions.
+
Explicit setup
--------------
+First, tell the toolbar not to adjust your settings automatically by adding
+this line in your settings module::
+
+ DEBUG_TOOLBAR_PATCH_SETTINGS = False
+
URLconf
~~~~~~~