Skip to content

Add note on lack of async support to docs #1829

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

Merged
merged 3 commits into from
Aug 30, 2023
Merged

Add note on lack of async support to docs #1829

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ebbab98
Add note on lack of async support to Installation docs
salomvary Aug 30, 2023
271acae
Add note on lack of async support to the Readme
salomvary Aug 30, 2023
ab5bfe3
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Aug 30, 2023
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
3 changes: 3 additions & 0 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,9 @@ contributed by the community.
The current stable version of the Debug Toolbar is 4.1.0. It works on
Django ≥ 3.2.4.

The Debug Toolbar does not currently support `Django's asynchronous views
<https://docs.djangoproject.com/en/dev/topics/async/>`_.

Documentation, including installation and configuration instructions, is
available at https://django-debug-toolbar.readthedocs.io/.

Expand Down
4 changes: 4 additions & 0 deletions docs/installation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@ Process
Each of the following steps needs to be configured for the Debug Toolbar to be
fully functional.

.. warning::

The Debug Toolbar does not currently support `Django's asynchronous views <https://docs.djangoproject.com/en/dev/topics/async/>`_.

1. Install the Package
^^^^^^^^^^^^^^^^^^^^^^

Expand Down