aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorAymeric Augustin2013-11-24 10:42:43 +0100
committerAymeric Augustin2013-11-24 11:01:44 +0100
commitfe3df822111d3b56000deca354b0bceed7bde9cc (patch)
tree8fe21689037cd975f83e7f70480b96e0ba2e3b6a /docs
parent7d24008ac3d70796c1502215c665311d2f21d6fd (diff)
downloaddjango-debug-toolbar-fe3df822111d3b56000deca354b0bceed7bde9cc.tar.bz2
Rename all panels consistently.
Enforce absolute imports to avoid clashing with built-in package names. Thanks Jannis for his feedback.
Diffstat (limited to 'docs')
-rw-r--r--docs/configuration.rst26
-rw-r--r--docs/panels.rst26
2 files changed, 26 insertions, 26 deletions
diff --git a/docs/configuration.rst b/docs/configuration.rst
index eefa527..7849d2e 100644
--- a/docs/configuration.rst
+++ b/docs/configuration.rst
@@ -11,19 +11,19 @@ This setting specifies the full Python path to each panel that you want
included in the toolbar. It works like Django's ``MIDDLEWARE_CLASSES``
setting. The default value is::
- DEBUG_TOOLBAR_PANELS = (
- 'debug_toolbar.panels.version.VersionDebugPanel',
- 'debug_toolbar.panels.timer.TimerDebugPanel',
- 'debug_toolbar.panels.settings_vars.SettingsVarsDebugPanel',
- 'debug_toolbar.panels.headers.HeaderDebugPanel',
- 'debug_toolbar.panels.request_vars.RequestVarsDebugPanel',
- 'debug_toolbar.panels.sql.SQLDebugPanel',
- 'debug_toolbar.panels.template.TemplateDebugPanel',
- 'debug_toolbar.panels.cache.CacheDebugPanel',
- 'debug_toolbar.panels.signals.SignalDebugPanel',
- 'debug_toolbar.panels.logger.LoggingPanel',
- 'debug_toolbar.panels.redirects.InterceptRedirectsPanel',
- )
+ DEBUG_TOOLBAR_PANELS = [
+ 'debug_toolbar.panels.versions.VersionsPanel',
+ 'debug_toolbar.panels.timer.TimerPanel',
+ 'debug_toolbar.panels.settings.SettingsPanel',
+ 'debug_toolbar.panels.headers.HeadersPanel',
+ 'debug_toolbar.panels.request.RequestPanel',
+ 'debug_toolbar.panels.sql.SQLPanel',
+ 'debug_toolbar.panels.template.TemplatesPanel',
+ 'debug_toolbar.panels.cache.CachePanel',
+ 'debug_toolbar.panels.signals.SignalsPanel',
+ 'debug_toolbar.panels.logging.LoggingPanel',
+ 'debug_toolbar.panels.redirects.RedirectsPanel',
+ ]
This setting allows you to:
diff --git a/docs/panels.rst b/docs/panels.rst
index 5ea4e44..39ddf7f 100644
--- a/docs/panels.rst
+++ b/docs/panels.rst
@@ -12,28 +12,28 @@ The following panels are enabled by default.
Version
~~~~~~~
-Path: ``debug_toolbar.panels.version.VersionDebugPanel``
+Path: ``debug_toolbar.panels.versions.VersionsPanel``
-Django version.
+Shows versions of Python, Django, and installed apps if possible.
Timer
~~~~~
-Path: ``debug_toolbar.panels.timer.TimerDebugPanel``
+Path: ``debug_toolbar.panels.timer.TimerPanel``
Request timer.
Settings
~~~~~~~~
-Path: ``debug_toolbar.panels.settings_vars.SettingsVarsDebugPanel``
+Path: ``debug_toolbar.panels.settings.SettingsPanel``
A list of settings in settings.py.
Headers
~~~~~~~
-Path: ``debug_toolbar.panels.headers.HeaderDebugPanel``
+Path: ``debug_toolbar.panels.headers.HeadersPanel``
This panels shows the HTTP request and response headers, as well as a
selection of values from the WSGI environment.
@@ -45,49 +45,49 @@ itself may also add response headers such as ``Date`` and ``Server``.
Request
~~~~~~~
-Path: ``debug_toolbar.panels.request_vars.RequestVarsDebugPanel``
+Path: ``debug_toolbar.panels.request.RequestPanel``
GET/POST/cookie/session variable display.
SQL
~~~
-Path: ``debug_toolbar.panels.sql.SQLDebugPanel``
+Path: ``debug_toolbar.panels.sql.SQLPanel``
SQL queries including time to execute and links to EXPLAIN each query.
Template
~~~~~~~~
-Path: ``debug_toolbar.panels.template.TemplateDebugPanel``
+Path: ``debug_toolbar.panels.templates.TemplatesPanel``
Templates and context used, and their template paths.
Cache
~~~~~
-Path: ``debug_toolbar.panels.cache.CacheDebugPanel``
+Path: ``debug_toolbar.panels.cache.CachePanel``
Cache queries.
Signal
~~~~~~
-Path: ``debug_toolbar.panels.signals.SignalDebugPanel``
+Path: ``debug_toolbar.panels.signals.SignalsPanel``
List of signals, their args and receivers.
Logging
~~~~~~~
-Path: ``debug_toolbar.panels.logger.LoggingPanel``
+Path: ``debug_toolbar.panels.logging.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``
+Path: ``debug_toolbar.panels.redirects.RedirectsPanel``
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
@@ -108,7 +108,7 @@ The following panels are disabled by default. You must add them to the
Profiling
~~~~~~~~~
-Path: ``debug_toolbar.panels.profiling.ProfilingDebugPanel``
+Path: ``debug_toolbar.panels.profiling.ProfilingPanel``
Profiling information for the view function.