From 69e353aa8a729b78a530d15cad9f887fed150d1b Mon Sep 17 00:00:00 2001 From: Michael Goerz Date: Tue, 4 Jun 2024 14:09:07 -0400 Subject: [PATCH] Add note about jQuery --- README.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.rst b/README.rst index 1e7d21a..5d35e49 100644 --- a/README.rst +++ b/README.rst @@ -81,6 +81,10 @@ Feedstock `_. Usage ----- +.. warning:: + + This plugin currently relies on jQuery, which is `no longer automatically included in Sphinx >= 6.0`_. You may need to add ``sphinxcontrib.jquery`` to the extensions list in ``conf.py`` in order for the versions menu to appear. + Showing a versions-menu in your documentation requires two steps: 1. Add ``'docs_versions_menu'`` to the list of extensions in your Sphinx ``conf.py``. @@ -154,3 +158,4 @@ The following projects use Docs-Versions-Menu_, respectively `its predecessor Do .. _make: https://www.gnu.org/software/make/manual/make.html .. _latex: https://www.latex-project.org .. _workflow file: https://github.com/goerz/docs_versions_menu/blob/master/.github/workflows/docs.yml +.. _no longer automatically included in Sphinx >= 6.0: https://github.com/sphinx-doc/sphinx/blob/548f0f928aab7c8f373604a0f65cce962e9807a5/CHANGES.rst#incompatible-changes-5