diff --git a/README.rst b/README.rst index 11257c993..70dbe5f76 100644 --- a/README.rst +++ b/README.rst @@ -43,8 +43,10 @@ contributed by the community. The current stable version of the Debug Toolbar is 5.0.0-alpha. It works on Django ≥ 4.2.0. -The Debug Toolbar does not currently support `Django's asynchronous views -`_. +The Debug Toolbar has experimental support for `Django's asynchronous views +`_. Please note that +the Debug Toolbar still lacks the capability for handling concurrent requests. +If you find any issues, please report them on the `issue tracker`_. Documentation, including installation and configuration instructions, is available at https://django-debug-toolbar.readthedocs.io/. @@ -56,3 +58,4 @@ The Django Debug Toolbar was originally created by Rob Hudson in August 2008 and was further developed by many contributors_. .. _contributors: https://github.com/django-commons/django-debug-toolbar/graphs/contributors +.. _issue tracker: https://github.com/django-commons/django-debug-toolbar/issues diff --git a/docs/changes.rst b/docs/changes.rst index b5d9a5b50..4aa78cece 100644 --- a/docs/changes.rst +++ b/docs/changes.rst @@ -8,6 +8,7 @@ Pending * Removed support for Python 3.8 as it has reached end of life. * Converted to Django Commons PyPI release process. * Fixed a crash which occurred when using non-``str`` static file values. +* Documented experimental async support. 5.0.0-alpha (2024-09-01) ------------------------ diff --git a/docs/installation.rst b/docs/installation.rst index 79e431176..7c5362005 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -245,11 +245,12 @@ And for Apache: Django Channels & Async ^^^^^^^^^^^^^^^^^^^^^^^ -The Debug Toolbar currently doesn't support Django Channels or async projects. -If you are using Django channels and you are having issues getting panels to -load, please review the documentation for the configuration option -:ref:`RENDER_PANELS `. +The Debug Toolbar currently has experimental support for Django Channels and +async projects. The Debug Toolbar is compatible with the following exceptions: +- Concurrent requests aren't supported +- ``TimerPanel``, ``RequestPanel`` and ``ProfilingPanel`` can't be used + in async contexts. HTMX ^^^^