docs: Enable “search as you type”

meltano · Jul 17, 2024 · 8666ed6 · 8666ed6
1 parent 32c059b
commit 8666ed6
Show file tree

Hide file tree

Showing 5 changed files with 55 additions and 97 deletions.
diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -3,7 +3,7 @@ version: 2
 build:
   os: ubuntu-22.04
   tools:
-    python: "3.11"
+    python: "3.12"
 
 sphinx:
   builder: html

diff --git a/docs/conf.py b/docs/conf.py
@@ -50,6 +50,7 @@
     "sphinx_reredirects",
     "sphinx_inline_tabs",
     "notfound.extension",
+    "sphinx_search.extension",
 ]
 
 # Add any paths that contain templates here, relative to this directory.

diff --git a/noxfile.py b/noxfile.py
@@ -186,7 +186,7 @@ def docs_serve(session: Session) -> None:
         "build",
         "-W",
     ]
-    session.install(".[docs]")
+    session.install(".[docs]", "sphinx-autobuild")
 
     build_dir = Path("build")
     if build_dir.exists():

diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -65,14 +65,14 @@ urllib3 = ">=1.26,<2"
 
 # Sphinx dependencies installed as optional 'docs' extras
 # https://github.com/readthedocs/readthedocs.org/issues/4912#issuecomment-664002569
-sphinx = {version = ">=4.5", optional = true}
-furo = {version = ">=2022.12.7", optional = true}
-sphinx-copybutton = {version = ">=0.3.1", optional = true}
-myst-parser = {version = ">=1", optional = true}
-sphinx-autobuild = {version = ">=2021.3.14", optional = true}
-sphinx-inline-tabs = {version = ">=2023.4.21", optional = true}
-sphinx-notfound-page = {version = ">=1.0.0", optional = true}
-sphinx-reredirects = {version = ">=0.1.1", optional = true}
+sphinx = {version = ">=7", python = ">=3.9", optional = true}
+furo = {version = ">=2024.5.6", python = ">=3.9", optional = true}
+sphinx-copybutton = {version = ">=0.5.2", python = ">=3.9", optional = true}
+myst-parser = {version = ">=3", python = ">=3.9", optional = true}
+readthedocs-sphinx-search = {version = ">=0.3.2", python = ">=3.9", optional = true}
+sphinx-inline-tabs = {version = ">=2023.4.21", python = ">=3.9", optional = true}
+sphinx-notfound-page = {version = ">=1.0.0", python = ">=3.9", optional = true}
+sphinx-reredirects = {version = ">=0.1.5", python = ">=3.9", optional = true}
 
 # File storage dependencies installed as optional 'filesystem' extras
 fs-s3fs = {version = ">=1.1.1", optional = true}
@@ -104,9 +104,9 @@ docs = [
     "furo",
     "myst-parser",
     "pytest",
+    "readthedocs-sphinx-search",
     "sphinx",
     "sphinx-copybutton",
-    "sphinx-autobuild",
     "sphinx-inline-tabs",
     "sphinx-notfound-page",
     "sphinx-reredirects",
@@ -252,8 +252,8 @@ DEP002 = [
     # Docs extras
     "furo",
     "myst-parser",
+    "readthedocs-sphinx-search",
     "sphinx",
-    "sphinx-autobuild",
     "sphinx-copybutton",
     "sphinx-inline-tabs",
     "sphinx-notfound-page",