Skip to content

Commit

Permalink
Documented experimental async support.
Browse files Browse the repository at this point in the history
  • Loading branch information
tim-schilling committed Dec 24, 2024
1 parent 5086e68 commit 8cf9d8d
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 6 deletions.
7 changes: 5 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
<https://docs.djangoproject.com/en/dev/topics/async/>`_.
The Debug Toolbar has experimental support for `Django's asynchronous views
<https://docs.djangoproject.com/en/dev/topics/async/>`_. 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/.
Expand All @@ -56,3 +58,4 @@ The Django Debug Toolbar was originally created by Rob Hudson <[email protected]>
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
1 change: 1 addition & 0 deletions docs/changes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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)
------------------------
Expand Down
9 changes: 5 additions & 4 deletions docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <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
^^^^
Expand Down

0 comments on commit 8cf9d8d

Please sign in to comment.