sphinxcontrib-jquery

4.1 · active · verified Thu Apr 09

sphinxcontrib-jquery is a Sphinx extension that provides jQuery for Sphinx projects running on versions 1.6 through 4.0. It was created to bridge a period where Sphinx core temporarily removed jQuery, ensuring compatibility for projects relying on it. The current version is 4.1.

Warnings

breaking Using `sphinxcontrib-jquery` with Sphinx versions 5.0 and newer will cause conflicts or be redundant. From Sphinx 5.0 onwards, jQuery is re-bundled into Sphinx core, making this extension unnecessary and potentially problematic.
Fix: Remove 'sphinxcontrib.jquery' from your `extensions` list in `conf.py` if your project uses Sphinx 5.0 or a newer version.
gotcha This extension is specifically designed for Sphinx versions between 1.6 and 4.0 (inclusive). Using it outside this range (e.g., with very old Sphinx versions < 1.6) may lead to unexpected behavior, errors, or a lack of desired functionality.
Fix: Ensure your Sphinx version is within the recommended range (1.6 to 4.0) if your project relies on this extension. For Sphinx versions outside this range, the extension might not provide its intended benefits or could cause issues.

Install

pip install sphinxcontrib-jquery Install library

Quickstart

To enable the `sphinxcontrib-jquery` extension, add 'sphinxcontrib.jquery' to the `extensions` list within your Sphinx project's `conf.py` configuration file.

# conf.py

# To enable the extension, add 'sphinxcontrib.jquery' to the extensions list
# in your Sphinx project's conf.py file.

extensions = [
    'sphinx.ext.autodoc',
    'sphinx.ext.napoleon',
    'sphinxcontrib.jquery', # <--- Add this line
    # ... other extensions
]

view raw JSON →