diff options
Diffstat (limited to 'docs/configuration.rst')
| -rw-r--r-- | docs/configuration.rst | 21 |
1 files changed, 14 insertions, 7 deletions
diff --git a/docs/configuration.rst b/docs/configuration.rst index 88226cd..ff4ece7 100644 --- a/docs/configuration.rst +++ b/docs/configuration.rst @@ -57,6 +57,13 @@ toolbar itself, others are specific to some panels. Toolbar options ~~~~~~~~~~~~~~~ +* ``DISABLE_PANELS`` + + Default: ``set(['debug_toolbar.panels.redirects.RedirectsPanel'])`` + + This setting is a set of the full Python paths to each panel that you + want disabled (but still displayed) by default. + * ``INSERT_BEFORE`` Default: ``'</body>'`` @@ -106,8 +113,8 @@ Toolbar options This is the dotted path to a function used for determining whether the toolbar should show or not. The default checks are that ``DEBUG`` must be set to ``True``, the IP of the request must be in ``INTERNAL_IPS``, and the - request must no be an AJAX request. You can provide your own function that - accepts a request in argument and returns ``True`` or ``False``. + request must no be an AJAX request. You can provide your own function + ``callback(request)`` which returns ``True`` or ``False``. Panel options ~~~~~~~~~~~~~ @@ -142,13 +149,14 @@ Panel options Useful for eliminating server-related entries which can result in enormous DOM structures and toolbar rendering delays. -* ``INTERCEPT_REDIRECTS`` +* ``PROFILER_MAX_DEPTH`` - Default: ``False`` + Default: ``10`` - Panel: redirects + Panel: profiling - If set to ``True``, the redirect panel will be active by default. + This setting affects the depth of function calls in the profiler's + analysis. * ``SHOW_TEMPLATE_CONTEXT`` @@ -178,6 +186,5 @@ Here's what a slightly customized toolbar configuration might look like:: 'RESULTS_STORE_SIZE': 3, 'SHOW_COLLAPSED': True, # Panel options - 'INTERCEPT_REDIRECTS': True, 'SQL_WARNING_THRESHOLD': 100, # milliseconds } |