docs: Enable “search as you type”

meltano · Jul 17, 2024 · bc483b1 · bc483b1
1 parent b566a5b
commit bc483b1
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 2 deletions.
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/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -69,6 +69,7 @@ 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}
@@ -103,6 +104,7 @@ docs = [
     "furo",
     "myst-parser",
     "pytest",
+    "readthedocs-sphinx-search",
     "sphinx",
     "sphinx-copybutton",
     "sphinx-inline-tabs",
@@ -250,6 +252,7 @@ DEP002 = [
     # Docs extras
     "furo",
     "myst-parser",
+    "readthedocs-sphinx-search",
     "sphinx",
     "sphinx-copybutton",
     "sphinx-inline-tabs",