Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/sphinx-doc/sphinx.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAdam Turner <9087854+aa-turner@users.noreply.github.com>2022-11-07 02:48:28 +0300
committerAdam Turner <9087854+aa-turner@users.noreply.github.com>2022-11-07 02:48:28 +0300
commita6032e852a650c070aed66f0790e612905159f15 (patch)
tree6f7e8008ba1dc64f7d9de6fd39202e024e4d23e4
parent2f60b44999d7e610d932529784f082fc1c6af989 (diff)
Recommend ``sphinxcontrib.jquery`` in CHANGES
-rw-r--r--CHANGES9
1 files changed, 9 insertions, 0 deletions
diff --git a/CHANGES b/CHANGES
index b04bc9fa5..1609cd396 100644
--- a/CHANGES
+++ b/CHANGES
@@ -18,6 +18,13 @@ Incompatible changes
``jQuery``, ``$``, or ``$u`` global objects, you need to update your
JavaScript to modern standards, or use the mitigation below.
+ The first option is to use the sphinxcontrib.jquery_ extension, which has been
+ developed by the Sphinx team and contributors. To use this, add
+ ``sphinxcontrib.jquery`` to the ``extensions`` list in ``conf.py``, or call
+ ``app.setup_extension("sphinxcontrib.jquery")`` if you develop a Sphinx theme
+ or extension.
+
+ The second option is to manually ensure that the frameworks are present.
To re-add jQuery and underscore.js, you will need to copy ``jquery.js`` and
``underscore.js`` from `the Sphinx repository`_ to your ``static`` directory,
and add the following to your ``layout.html``:
@@ -30,6 +37,8 @@ Incompatible changes
{{ super() }}
{%- endblock %}
+ .. _sphinxcontrib.jquery: https://github.com/sphinx-contrib/jquery/
+
Patch by Adam Turner.
* #10471, #10565: Removed deprecated APIs scheduled for removal in Sphinx 6.0. See
:ref:`dev-deprecated-apis` for details. Patch by Adam Turner.