From c9a9d042e5182cfb6c9aceaf292e5e3727f624dd Mon Sep 17 00:00:00 2001 From: Jon Dufresne Date: Thu, 14 May 2020 10:25:06 +0200 Subject: [PATCH] [3.1.x] Refs #31034 -- Documented admin requires django.template.context_processors.request. Required since d24ba1be7a53a113d19e2860c03aff9922efec24. Co-authored-by: Carlton Gibson Backport of e341bed606d8ab2864838795276692cf86b08687 from master --- docs/ref/contrib/admin/index.txt | 9 ++++++++- docs/releases/3.1.txt | 5 +++++ docs/spelling_wordlist | 1 + 3 files changed, 14 insertions(+), 1 deletion(-) diff --git a/docs/ref/contrib/admin/index.txt b/docs/ref/contrib/admin/index.txt index 664379c03b..3fbf1bb6ed 100644 --- a/docs/ref/contrib/admin/index.txt +++ b/docs/ref/contrib/admin/index.txt @@ -34,11 +34,18 @@ If you're not using the default project template, here are the requirements: #. Configure a :class:`~django.template.backends.django.DjangoTemplates` backend in your :setting:`TEMPLATES` setting with - ``django.contrib.auth.context_processors.auth`` and + ``django.contrib.auth.context_processors.auth``, + ``django.contrib.messages.context_processors.request``, and ``django.contrib.messages.context_processors.messages`` in the ``'context_processors'`` option of :setting:`OPTIONS `. + .. versionchanged:: 3.1 + + ``django.contrib.messages.context_processors.request`` was added as a + requirement in the ``'context_processors'`` option to support the new + :attr:`.AdminSite.enable_nav_sidebar`. + #. If you've customized the :setting:`MIDDLEWARE` setting, :class:`django.contrib.auth.middleware.AuthenticationMiddleware` and :class:`django.contrib.messages.middleware.MessageMiddleware` must be diff --git a/docs/releases/3.1.txt b/docs/releases/3.1.txt index 268e92433c..1b2c1fee34 100644 --- a/docs/releases/3.1.txt +++ b/docs/releases/3.1.txt @@ -96,6 +96,11 @@ Minor features enabled by default but can be disabled by using a custom ``AdminSite`` and setting :attr:`.AdminSite.enable_nav_sidebar` to ``False``. + Rendering the sidebar requires access to the current request in order to set + CSS and ARIA role affordances. This requires using + ``'django.template.context_processors.request'`` in the + ``'context_processors'`` option of :setting:`OPTIONS `. + * ``XRegExp`` is upgraded from version 2.0.0 to 3.2.0. * jQuery is upgraded from version 3.4.1 to 3.5.1. diff --git a/docs/spelling_wordlist b/docs/spelling_wordlist index cb1d869147..61e4702275 100644 --- a/docs/spelling_wordlist +++ b/docs/spelling_wordlist @@ -6,6 +6,7 @@ admin admindocs admins affine +affordances aggregator Ai Alchin