summaryrefslogtreecommitdiffstats
path: root/README.rst
diff options
context:
space:
mode:
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst45
1 files changed, 45 insertions, 0 deletions
diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..50e365a
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,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