Skip to main content

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sphinxcontrib-jquery-4.1.tar.gz (122.3 kB view hashes)

Uploaded Source

Built Distribution

sphinxcontrib_jquery-4.1-py2.py3-none-any.whl (121.1 kB view hashes)

Uploaded Python 2 Python 3

Supported by

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