diff options
| author | Aymeric Augustin | 2013-11-15 20:45:32 +0100 |
|---|---|---|
| committer | Aymeric Augustin | 2013-11-15 20:45:32 +0100 |
| commit | e89992a951b05b20dcd5c59927041d41b23110c9 (patch) | |
| tree | fd51cafbcc151bb44c7d363810031bae70067468 /docs | |
| parent | 57e3169fe3ca4b6bd23faee12911b3177eba8aa4 (diff) | |
| download | django-debug-toolbar-e89992a951b05b20dcd5c59927041d41b23110c9.tar.bz2 | |
Implement redirects interception as a panel.
Fix #122.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/configuration.rst | 18 | ||||
| -rw-r--r-- | docs/panels.rst | 15 |
2 files changed, 24 insertions, 9 deletions
diff --git a/docs/configuration.rst b/docs/configuration.rst index df203cb..05500d9 100644 --- a/docs/configuration.rst +++ b/docs/configuration.rst @@ -22,6 +22,7 @@ setting. The default value is:: 'debug_toolbar.panels.cache.CacheDebugPanel', 'debug_toolbar.panels.signals.SignalDebugPanel', 'debug_toolbar.panels.logger.LoggingPanel', + 'debug_toolbar.panels.redirects.InterceptRedirectsPanel', ) This setting allows you to: @@ -54,15 +55,6 @@ Toolbar options right thing depending on whether the WSGI container runs multiple processes. This setting allows you to force a different behavior if needed. -* ``INTERCEPT_REDIRECTS`` - - Default: ``False`` - - If set to ``True``, the debug toolbar will show an intermediate page upon - redirect so you can view any debug information prior to redirecting. This - page will provide a link to the redirect destination you can follow when - ready. If set to ``False``, redirects will proceed as normal. - * ``RESULTS_CACHE_SIZE`` Default: ``10`` @@ -139,6 +131,14 @@ Panel options If set to ``True`` then code in Django itself won't be shown in stacktraces. +* ``INTERCEPT_REDIRECTS`` + + Default: ``False`` + + Panel: redirects + + If set to ``True``, the redirect panel will be active by default. + * ``SHOW_TEMPLATE_CONTEXT`` Default: ``True`` diff --git a/docs/panels.rst b/docs/panels.rst index b5b7b2e..5ea4e44 100644 --- a/docs/panels.rst +++ b/docs/panels.rst @@ -84,6 +84,21 @@ Path: ``debug_toolbar.panels.logger.LoggingPanel`` Logging output via Python's built-in :mod:`logging`, or via the `logbook <http://logbook.pocoo.org>`_ module. +Redirects +~~~~~~~~~ + +Path: ``debug_toolbar.panels.redirects.InterceptRedirectsPanel`` + +When this panel is enabled, the debug toolbar will show an intermediate page +upon redirect so you can view any debug information prior to redirecting. This +page will provide a link to the redirect destination you can follow when +ready. + +Since this behavior is annoying when you aren't debugging a redirect, this +panel is included but inactive by default. You can activate it by default with +the ``INTERCEPT_REDIRECTS`` configuration option. + + Non-default built-in panels --------------------------- |