Update docs dependencies; fix docs search; add readthedocs.yaml (#935)

fixes: #925 Fix for missing jquery in search: readthedocs/sphinx_rtd_theme#1452
jieter · Nov 13, 2023 · 35f9616 · 35f9616
1 parent 2318bc1
commit 35f9616
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 3 deletions.
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -0,0 +1,19 @@
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+
+python:
+  install:
+   - requirements: docs/requirements.txt
diff --git a/docs/conf.py b/docs/conf.py
@@ -31,6 +31,7 @@
     "sphinx.ext.napoleon",
     "sphinx.ext.viewcode",
     "sphinx.ext.doctest",
+    "sphinxcontrib.jquery",
     "sphinxcontrib.spelling",
     "myst_parser",
 ]

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,7 +1,7 @@
 -r ../requirements/common.pip
-Sphinx==6.1.3
-sphinx_rtd_theme==1.2.0
+Sphinx==7.2.6
+sphinx_rtd_theme==1.3.0
 django
 sphinxcontrib-spelling==8.0.0
 pyenchant==3.2.2
-myst-parser==0.19.1
+myst-parser==2.0.0