diff options
| author | Aymeric Augustin | 2013-11-13 20:40:22 +0100 | 
|---|---|---|
| committer | Aymeric Augustin | 2013-11-13 20:40:22 +0100 | 
| commit | 97090c32941784d28818721f37eee69e21e2d74e (patch) | |
| tree | fdabb0301faf9595312b908e738638d18ecffacb /docs | |
| parent | a3acf6b57275f2a14cde7c209a8b6dff107275b0 (diff) | |
| download | django-debug-toolbar-97090c32941784d28818721f37eee69e21e2d74e.tar.bz2 | |
Provide an option to force rendering panels in page.
Requested by David who seems to runs the debug toolbar in production :-)
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/configuration.rst | 14 | ||||
| -rw-r--r-- | docs/installation.rst | 5 | 
2 files changed, 16 insertions, 3 deletions
| diff --git a/docs/configuration.rst b/docs/configuration.rst index 129b0e0..d8cf9a9 100644 --- a/docs/configuration.rst +++ b/docs/configuration.rst @@ -40,6 +40,20 @@ toolbar itself, others are specific to some panels.  Toolbar options  ~~~~~~~~~~~~~~~ +* ``RENDER_PANELS`` + +  Default: ``None`` + +  If set to ``False``, the debug toolbar will keep the contents of panels in +  memory on the server and load them on demand. If set to ``True``, it will +  render panels inside every page. This may slow down page rendering but it's +  required on multi-process servers, for example if you deploy the toolbar in +  production (which isn't recommended). + +  The default value of ``None`` tells the toolbar to automatically do the +  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`` diff --git a/docs/installation.rst b/docs/installation.rst index 3d71e12..5d046a2 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -41,9 +41,8 @@ what it does, or if you prefer defining your settings explicitly, read below.      The automatic setup relies on ``debug_toolbar.models`` being imported when      the server starts. Django doesn't provide a better hook to execute code -    during the start-up sequence. This works with Django's built-in -    development server ``runserver`` because it validates models before -    serving requests. You should use the explicit setup with other servers. +    during the start-up sequence. This works with ``manage.py runserver`` +    because it validates models before serving requests.  Explicit setup  -------------- | 
