sphinxcontrib-jquery

What it is and what it does

sphinxcontrib-jquery is a Sphinx extension that guarantees jQuery is available when building documentation. It solves the problem of jQuery availability in Sphinx themes and extensions that depend on it, particularly useful for older themes or extensions that still require jQuery but may not bundle it themselves. The extension is configured by adding it to the extensions list in conf.py and optionally enabling subresource integrity checks via the jquery_use_sri configuration option.

The package has low install friction—it depends only on Sphinx itself—and is marked Production/Stable. However, maintenance is dormant: the last commit was in July 2024 and the most recent release was over a year ago. It carries no known security vulnerabilities and supports a wide range of Python versions from 2.7 through 3.11.

Use it for:

• Enable jQuery in Sphinx documentation builds when using themes that require it but don't bundle it.
• Add jQuery to custom Sphinx extensions that use jQuery-based JavaScript without managing the library separately.
• Enable subresource integrity checks for JavaScript files in Sphinx builds when jquery_use_sri is set to True.
• Maintain compatibility with older Sphinx themes that depend on jQuery being present at build time.

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

A Sphinx extension that ensures jQuery is available for use by Sphinx themes and extensions, with optional subresource integrity (SRI) checks for loaded JavaScript files.

Yes, if you are using a Sphinx theme or extension that requires jQuery. The package is stable, has no security issues, and installs with minimal friction. The dormant maintenance status is not a blocker for a simple utility like this, but be aware that updates may be slow if issues arise. If your theme or extension does not depend on jQuery, there is no reason to install it.

Install

sphinxcontrib-jquery on PyPI

pip install sphinxcontrib-jquery

uv add sphinxcontrib-jquery

poetry add sphinxcontrib-jquery

Installing sphinxcontrib-jquery

Before you install

Low friction to install. Marked as dormant with last commit in July 2024 and no release for over a year; however, it remains marked Production/Stable and carries no known vulnerabilities.

License in practice

Licensed under BSD (permissive), so you can use it freely in most projects without significant legal constraints.

Quickstart

pip install sphinxcontrib-jquery

# In conf.py
extensions = [
    "sphinxcontrib.jquery",
]

Verify before relying

• Whether jQuery version bundled or loaded is documented and matches current jQuery releases.
• Whether SRI checks work reliably with all Sphinx versions and documentation hosting scenarios.

Package facts

Evidence: sphinxcontrib_jquery-4.1-py2.py3-none-any.whl

Tags

More Documentation packages