From 64c942c68aa48a2af2302eefbf2950034b25e9bb Mon Sep 17 00:00:00 2001 From: baldurk Date: Fri, 3 Jul 2026 11:09:09 +0100 Subject: [PATCH] Include license and readme for sphinxcontrib-jquery --- docs/sphinx_exts/sphinxcontrib_jquery/LICENCE | 14 ++++++ .../sphinxcontrib_jquery/README.rst | 45 +++++++++++++++++++ 2 files changed, 59 insertions(+) create mode 100644 docs/sphinx_exts/sphinxcontrib_jquery/LICENCE create mode 100644 docs/sphinx_exts/sphinxcontrib_jquery/README.rst diff --git a/docs/sphinx_exts/sphinxcontrib_jquery/LICENCE b/docs/sphinx_exts/sphinxcontrib_jquery/LICENCE new file mode 100644 index 000000000..3a77985ee --- /dev/null +++ b/docs/sphinx_exts/sphinxcontrib_jquery/LICENCE @@ -0,0 +1,14 @@ +BSD Zero Clause Licence + +Copyright 2022, Adam Turner + +Permission to use, copy, modify, and/or distribute this software for any +purpose with or without fee is hereby granted. + +THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH +REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY +AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, +INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM +LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR +OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR +PERFORMANCE OF THIS SOFTWARE. diff --git a/docs/sphinx_exts/sphinxcontrib_jquery/README.rst b/docs/sphinx_exts/sphinxcontrib_jquery/README.rst new file mode 100644 index 000000000..50e365a90 --- /dev/null +++ b/docs/sphinx_exts/sphinxcontrib_jquery/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