sphinxcontrib-jquery

.gitignore

@@ -0,0 +1,35 @@
+*.pyc
+*.egg
+*.so
+*.swp
+
+.dir-locals.el
+.cache/
+.idea
+.mypy_cache/
+.pytest_cache/
+.ropeproject/
+.vscode/
+TAGS
+.tags
+.tox/
+.tx/
+.venv/
+.coverage
+htmlcov
+.DS_Store
+sphinx/pycode/Grammar*pickle
+distribute-*
+
+env/
+build/
+dist/
+docker/
+Sphinx.egg-info/
+doc/_build/
+doc/locale/
+tests/.coverage
+tests/build/
+utils/regression_test.js
+
+node_modules/

AUTHORS

@@ -0,0 +1,6 @@
+Maintainers
+===========
+
+*Listed alphabetically in forename, surname order*
+
+* Adam Turner <@AA-Turner>

CHANGES.rst

@@ -0,0 +1,4 @@
+Release 1.0.0 (in development)
+==============================
+
+* Initial release of ``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.

README.rst

@@ -0,0 +1,21 @@
+======================
+ 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",
+   ]
+   ...

pyproject.toml

@@ -0,0 +1,39 @@
+[build-system]
+requires = ["setuptools>=65"]
+build-backend = "setuptools.build_meta"
+
+# project metadata
+[project]
+name = "sphinxcontrib-jquery"
+version = "1.0.0"
+description = "Extension to include jQuery on newer Sphinx releases"
+readme = "README.rst"
+license.text = "BSD Zero Clause License"
+requires-python = ">=3.7"
+
+# Classifiers list: https://pypi.org/classifiers/
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "License :: OSI Approved :: BSD License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.7",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: Implementation :: CPython",
+    "Programming Language :: Python :: Implementation :: PyPy",
+    "Framework :: Sphinx",
+    "Framework :: Sphinx :: Extension",
+    "Topic :: Documentation",
+    "Topic :: Documentation :: Sphinx",
+]
+dependencies = [
+    "setuptools",  # for pkg_resources
+]
+
+[[project.authors]]
+name = "Adam Turner"

sphinxcontrib/__init__.py

@@ -0,0 +1,2 @@
+# -*- coding: utf-8 -*-
+__import__('pkg_resources').declare_namespace(__name__)

sphinxcontrib/jquery.py

@@ -0,0 +1,20 @@
+import sphinx
+
+__version__ = "1.0.0"
+version_info = (1, 0, 0)
+
+
+def setup(app: "sphinx.application.Sphinx"):
+    jquery_installed = getattr(app, "_sphinxcontrib_jquery_installed", False)
+    if sphinx.version_info[:2] >= (6, 0) and not jquery_installed:
+        app.add_js_file(
+            "https://ajax.googleapis.com/ajax/libs/jquery/3.6.0/jquery.min.js",
+            priority=100,
+        )
+        app._sphinxcontrib_jquery_installed = True
+
+    return {
+        "parallel_read_safe": True,
+        "parallel_write_safe": True,
+        "version": "1.0.0",
+    }