https://github.com/sphinx-contrib/jquery

Extension to include jQuery on newer Sphinx releases
https://github.com/sphinx-contrib/jquery

Last synced: 4 months ago
JSON representation

Extension to include jQuery on newer Sphinx releases

• Host: GitHub
• URL: https://github.com/sphinx-contrib/jquery
• Owner: sphinx-contrib
• License: 0bsd
• Created: 2022-10-17T16:53:03.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2024-07-15T20:14:37.000Z (10 months ago)
• Last Synced: 2025-01-06T09:09:18.477Z (4 months ago)
• Language: Python
• Size: 127 KB
• Stars: 10
• Watchers: 5
• Forks: 7
• Open Issues: 8
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGES.rst
  • Authors: AUTHORS

Awesome Lists containing this project

README

        
======================

 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