blob: 50e365a9091df909d7d882f540e5e8eaf6c05209 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
|
======================
sphinxcontrib-jquery
======================
.. image:: https://img.shields.io/pypi/v/sphinxcontrib-jquery.svg
:target: https://pypi.org/project/sphinxcontrib-jquery/
:alt: 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:
.. code:: python
# conf.py
extensions = [
"sphinxcontrib.jquery",
]
...
Configuration
-------------
.. As this is a README, we restrict the directives we use to those which GitHub
renders correctly. This means that we cannot use ``versionadded``,
``confval``, ``warning``, or other similar directives.
We use a reStructuredText definition list to emulate the ``confval``
rendering.
We use inline **bold** syntax as a poor-man's ``.. warning::`` directive.
``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.*
.. _subresource integrity: https://developer.mozilla.org/en-US/docs/Web/Security/Subresource_Integrity
|
