Add sphinx docsearch extension

Load from env variables

Author: BillHuang2001

docs/source/conf.py

@@ -40,11 +40,17 @@
     "sphinx_design",
     "sphinx_favicon",
     "sphinxcontrib.mermaid",
-    # "nbsphinx",
-    # "myst_parser",
     "myst_nb",
+    "sphinx_docsearch",
 ]
 
+# The API key is a search-only key, so it is safe to expose in public repositories.
+# but some tools won't happy about having a "api_key" in the public repo,
+# so we load from the environment variable.
+docsearch_app_id = "MMXVFW6EQH"
+docsearch_api_key = os.environ.get("DOCSEARCH_API_KEY", "")
+docsearch_index_name = "evox"
+
 autodoc2_packages = [
     "../../src/evox",
 ]

pyproject.toml

@@ -59,6 +59,7 @@ docs = [
   "sphinx_copybutton",
   "sphinx_design",
   "sphinx-favicon",
+  "sphinx-docsearch",
   "sphinxcontrib-mermaid",
   "polib",
 ]