aboutsummaryrefslogtreecommitdiffstats
path: root/README.rst
diff options
context:
space:
mode:
authorRob Hudson2009-09-12 16:55:15 -0700
committerRob Hudson2009-09-12 16:55:15 -0700
commit9801c8b0a312bd18ff20414d72bb5b5f9c941018 (patch)
tree8032c47ff263cd6dc81aa9506140f001ea27a43f /README.rst
parentb7d7e9f876b67be35d8a24405f6940b2dcb66e97 (diff)
parentd6190014abd950f032755fde33ce32c30fc0e754 (diff)
downloaddjango-debug-toolbar-9801c8b0a312bd18ff20414d72bb5b5f9c941018.tar.bz2
Merge remote branch 'alex/master'
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst23
1 files changed, 16 insertions, 7 deletions
diff --git a/README.rst b/README.rst
index c80e005..8d2d5a0 100644
--- a/README.rst
+++ b/README.rst
@@ -3,7 +3,7 @@ Django Debug Toolbar
====================
The Django Debug Toolbar is a configurable set of panels that display various
-debug information about the current request/response and when clicked, display
+debug information about the current request/response and when clicked, display
more details about the panel's content.
Currently, the following panels have been written and are working:
@@ -32,8 +32,8 @@ Installation
Tying into middleware allows each panel to be instantiated on request and
rendering to happen on response.
- The order of MIDDLEWARE_CLASSES is important: the Debug Toolbar middleware
- must come after any other middleware that encodes the response's content
+ The order of MIDDLEWARE_CLASSES is important: the Debug Toolbar middleware
+ must come after any other middleware that encodes the response's content
(such as GZipMiddleware).
Note: The debug toolbar will only display itself if the mimetype of the
@@ -60,9 +60,9 @@ Configuration
The debug toolbar has two settings that can be set in `settings.py`:
-#. Optional: Add a tuple called `DEBUG_TOOLBAR_PANELS` to your ``settings.py``
- file that specifies the full Python path to the panel that you want included
- in the Toolbar. This setting looks very much like the `MIDDLEWARE_CLASSES`
+#. Optional: Add a tuple called `DEBUG_TOOLBAR_PANELS` to your ``settings.py``
+ file that specifies the full Python path to the panel that you want included
+ in the Toolbar. This setting looks very much like the `MIDDLEWARE_CLASSES`
setting. For example::
DEBUG_TOOLBAR_PANELS = (
@@ -101,15 +101,24 @@ The debug toolbar has two settings that can be set in `settings.py`:
* `EXTRA_SIGNALS`: An array of custom signals that might be in your project,
defined as the python path to the signal.
+ * `HIDE_DJANGO_SQL`: If set to True (the default) then code in Django itself
+ won't be shown in SQL stacktraces.
+
+ * `SHOW_TEMPLATE_CONTEXT`: If set to True (the default) then a template's
+ context will be included with it in the Template debug panel. Turning this
+ off is useful when you have large template contexts, or you have template
+ contexts with lazy datastructures that you don't want to be evaluated.
+
Example configuration::
def custom_show_toolbar(request):
return True # Always show toolbar, for example purposes only.
-
+
DEBUG_TOOLBAR_CONFIG = {
'INTERCEPT_REDIRECTS': False,
'SHOW_TOOLBAR_CALLBACK': custom_show_toolbar,
'EXTRA_SIGNALS': ['myproject.signals.MySignal'],
+ 'HIDE_DJANGO_SQL': False,
}
TODOs and BUGS