Add note on lack of async support to docs (#1829)

* Add note on lack of async support to Installation docs * Add note on lack of async support to the Readme #1828 (comment)
jazzband · Aug 30, 2023 · a344da1 · a344da1
1 parent c911d73
commit a344da1
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 0 deletions.
diff --git a/README.rst b/README.rst
@@ -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/.
 

diff --git a/docs/installation.rst b/docs/installation.rst
@@ -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
 ^^^^^^^^^^^^^^^^^^^^^^