Skip to main content
PyCon US is happening May 14th-22nd in Pittsburgh, PA USA.  Learn more

Extension to include jQuery on newer Sphinx releases

Project description

Package on PyPI

sphinxcontrib-jquery ensures that jQuery is always installed for use in Sphinx themes or extensions.

To use it, add sphinxcontrib.jquery as a Sphinx extension:

# conf.py

extensions = [
    "sphinxcontrib.jquery",
]
...

Configuration

jquery_use_sri

A boolean value controlling whether to enable subresource integrity (SRI) checks for JavaScript files that this extension loads.

The default is False.

Warning: Enabling SRI checks may break documentation when loaded from local filesystem (file:/// URIs).

New in version 4.0.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page