Skip to content

Commit

Permalink
Add note about jQuery
Browse files Browse the repository at this point in the history
  • Loading branch information
goerz committed Jun 4, 2024
1 parent 2e7e6d3 commit 69e353a
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,10 @@ Feedstock <conda-feedstock-instructions_>`_.
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``.
Expand Down Expand Up @@ -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

0 comments on commit 69e353a

Please sign in to comment.