Extension to include jQuery on newer Sphinx releases
Project Links
Meta
Author: Adam Turner
Requires Python: >=2.7
Classifiers
Development Status
- 5 - Production/Stable
License
- OSI Approved :: BSD License
Operating System
- OS Independent
Programming Language
- Python
- Python :: 2
- Python :: 3
- Python :: 2.7
- Python :: 3.5
- Python :: 3.6
- Python :: 3.7
- Python :: 3.8
- Python :: 3.9
- Python :: 3.10
- Python :: 3.11
- Python :: Implementation :: CPython
- Python :: Implementation :: PyPy
Framework
- Sphinx
- Sphinx :: Extension
Topic
- Documentation
- Documentation :: Sphinx
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.
Wheel compatibility matrix
Files in release
Extras:
None
Dependencies:
Sphinx
(>=1.8)