Skip to content

Commit a6032e8

Browse files
committed
Recommend sphinxcontrib.jquery in CHANGES
1 parent 2f60b44 commit a6032e8

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

CHANGES

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,13 @@ Incompatible changes
1818
``jQuery``, ``$``, or ``$u`` global objects, you need to update your
1919
JavaScript to modern standards, or use the mitigation below.
2020

21+
The first option is to use the sphinxcontrib.jquery_ extension, which has been
22+
developed by the Sphinx team and contributors. To use this, add
23+
``sphinxcontrib.jquery`` to the ``extensions`` list in ``conf.py``, or call
24+
``app.setup_extension("sphinxcontrib.jquery")`` if you develop a Sphinx theme
25+
or extension.
26+
27+
The second option is to manually ensure that the frameworks are present.
2128
To re-add jQuery and underscore.js, you will need to copy ``jquery.js`` and
2229
``underscore.js`` from `the Sphinx repository`_ to your ``static`` directory,
2330
and add the following to your ``layout.html``:
@@ -30,6 +37,8 @@ Incompatible changes
3037
{{ super() }}
3138
{%- endblock %}
3239

40+
.. _sphinxcontrib.jquery: https://github.com/sphinx-contrib/jquery/
41+
3342
Patch by Adam Turner.
3443
* #10471, #10565: Removed deprecated APIs scheduled for removal in Sphinx 6.0. See
3544
:ref:`dev-deprecated-apis` for details. Patch by Adam Turner.

0 commit comments

Comments
 (0)