Use sphinx-docsearch

Signed-off-by: Vivek Joshy <[email protected]>

.github/workflows/main.yml

@@ -19,7 +19,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [Ubuntu, MacOS, Windows]
-        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
         architecture: ["x86", "x64"]
         experimental: [false]
     defaults:
@@ -100,7 +100,7 @@ jobs:
       fail-fast: true
       matrix:
         os: [Ubuntu, MacOS, Windows]
-        python-version: ["pypy3.9", "pypy3.10"]
+        python-version: ["pypy3.10"]
         architecture: ["x64"]
         experimental: [false]
     defaults:

docs/doc_requires.txt

@@ -1,11 +1,13 @@
-sphinx~=7.4
+sphinx~=8.1
 nbsphinx~=0.9
 pygments~=2.18
 shibuya~=2024.7
 ipykernel~=6.29
-myst_parser~=3.0  # Must Be Underscore, not Hyphen
+matplotlib~=3.9
+myst_parser~=4.0  # Must Be Underscore, not Hyphen
 sphinx-intl~=2.2
 sphinx_favicon~=1.0
+sphinx-docsearch~=0.1
 sphinx-copybutton~=0.5
 sphinx-autoapi~=3.1
 sphinxext-opengraph~=0.9

docs/source/conf.py

@@ -36,6 +36,7 @@
     "sphinx_copybutton",
     "myst_parser",
     "nbsphinx",
+    "sphinx_docsearch"
 ]
 
 templates_path: List[str] = ["_templates"]
@@ -125,17 +126,8 @@
     },
 ]
 
-
-# -- Custom CSS and JS -------------------------------------------------------
-
-
-def setup(app):
-    # CSS
-    app.add_css_file(
-        "https://cdn.jsdelivr.net/npm/@docsearch/css@3", type="text/css; charset=utf-8"
-    )
-    app.add_css_file("css/custom.css")
-
-    # JavaScript
-    app.add_js_file("https://cdn.jsdelivr.net/npm/@docsearch/js@3")
-    app.add_js_file("js/custom.js")
+# Docsearch
+docsearch_app_id = "TUWNQQ885H"
+docsearch_api_key = "19a09d80f4b370188bea620ff3738fb1"
+docsearch_index_name = "openskill"
+nbsphinx_requirejs_path = ''

pyproject.toml

@@ -37,7 +37,7 @@ doctest_optionflags = "NUMBER"
 profile = "black"
 
 [tool.mypy]
-python_version = "3.9"
+python_version = "3.10"
 strict = true
 
 [project]
@@ -51,7 +51,7 @@ maintainers = [
 ]
 description = "Multiplayer Rating System. No Friction."
 readme = "README.md"
-requires-python = "~=3.9"
+requires-python = "~=3.10"
 keywords = ["ranking", "trueskill", "statistics", "rating", "math", "rank"]
 license = {text = "MIT"}
 classifiers = [
@@ -82,9 +82,11 @@ dev-dependencies = [
     "pygments~=2.18",
     "shibuya~=2024.7",
     "ipykernel~=6.29",
+    "matplotlib~=3.9",
     "myst-parser~=4.0",
     "sphinx-intl~=2.2",
     "sphinx-favicon~=1.0",
+    "sphinx-docsearch~=0.1",
     "sphinx-copybutton~=0.5",
     "sphinx-autoapi~=3.1",
     "sphinxext-opengraph~=0.9",