Skip to content

Document Django Debug Toolbar system checks #1345

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
jdufresne wants to merge 2 commits into from
Closed

Document Django Debug Toolbar system checks #1345

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a61e67a
Document Django Debug Toolbar system checks
jdufresne Sep 26, 2020
ec4cb42
Merge branch 'master' into document-system-checks
matthiask Sep 30, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Document Django Debug Toolbar system checks 
Follows a layout that is similar to Django's documentation:
https://docs.djangoproject.com/en/dev/ref/checks/
  • Loading branch information
@jdufresne
jdufresne committed Sep 26, 2020
commit a61e67a6cc0f1db9b1a35a0b301970c01c7fa723
15 changes: 15 additions & 0 deletions docs/checks.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
=============
System checks
=============

The following :doc:`system checks <topics/checks>` help verify the Django
Debug Toolbar setup and configuration:

* **debug_toolbar.W001**: ``debug_toolbar.middleware.DebugToolbarMiddleware``
is missing from ``MIDDLEWARE``.
* **debug_toolbar.W002**: ``debug_toolbar.middleware.DebugToolbarMiddleware``
occurs multiple times in ``MIDDLEWARE``.
* **debug_toolbar.W003**: ``debug_toolbar.middleware.DebugToolbarMiddleware``
occurs before ``django.middleware.gzip.GZipMiddleware`` in ``MIDDLEWARE``.
* **debug_toolbar.W004**: ``debug_toolbar`` is incompatible with
``MIDDLEWARE_CLASSES`` setting.
1 change: 1 addition & 0 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ Django Debug Toolbar

installation
configuration
checks
tips
panels
commands
Expand Down