Registry / web-framework / sphinxcontrib-jquery

sphinxcontrib-jquery

JSON →
library4.1pypypiunverified

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.

web-framework
pip install sphinxcontrib-jquery
github ↗package ↗
INSTALL
IMPORT
SIG · SPHINXCONTRIB-JQUE
S
sphinxcontrib-jquery
web-frameworkpythonv4.1
harness data pending
Install & Compatibility
Where this runs

No compatibility data collected yet for this library.

Code
Verified usage

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 ]
Debug
Known issues
breakingUsing `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.
affects: Sphinx >= 5.0
gotchaThis 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.
affects: Sphinx < 1.6
Errors
Common errors & fixes
ModuleNotFoundError: No module named 'sphinxcontrib.jquery'
The 'sphinxcontrib-jquery' Python package is not installed in the environment where Sphinx is being run.
fix
pip install sphinxcontrib-jquery
WARNING: The jquery extension is not needed for Sphinx >= 5.0.0. Please remove "sphinxcontrib.jquery" from your extensions list in conf.py.
The 'sphinxcontrib-jquery' extension is enabled in your `conf.py` but is not necessary when using Sphinx version 5.0 or newer, which bundles its own jQuery.
fix
Remove `'sphinxcontrib.jquery'` from the `extensions` list in your `conf.py` file.
WARNING: unknown extension: sphinxcontrib-jquery
The extension name in the `extensions` list in `conf.py` uses a hyphen (`-`) instead of a dot (`.`), preventing Sphinx from finding the correct module.
fix
Change `'sphinxcontrib-jquery'` to `'sphinxcontrib.jquery'` in the `extensions` list in your `conf.py` file.
Upgrade
Version history
4.1latest on PyPI · released Mar 14, 2023
Audit
Dependencies

No dependency data recorded yet.

Agent activity
6 hits · last 30 days
node
4
Resources
githubhttps://github.com/sphinx-contrib/jquery ↗
packagehttps://pypi.org/project/sphinxcontrib-jquery/ ↗
sphinxcontrib-jquery — pip install sphinxcontrib-jquery · libregistry