Use Read The Docs Sphinx theme

docs/conf.py

@@ -28,7 +28,12 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = ["sphinx.ext.autodoc", "sphinx.ext.viewcode", "sphinx.ext.doctest"]
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.viewcode",
+    "sphinx.ext.doctest",
+    "sphinx_rtd_theme",
+]
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]
@@ -98,7 +103,7 @@
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = "default"
+html_theme = "sphinx_rtd_theme"
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the

pyproject.toml

@@ -59,6 +59,7 @@ dev = [
   "pip-tools",
   "pytest-cov",
   "pytest",
+  "sphinx-rtd-theme",
   "sphinx==7.1.2",
   "sphinxcontrib-applehelp==1.0.4",
   "sphinxcontrib-devhelp==1.0.2",

requirements-dev.txt

@@ -23,7 +23,9 @@ coverage[toml]==7.4.0
     #   metsrw (pyproject.toml)
     #   pytest-cov
 docutils==0.20.1
-    # via sphinx
+    # via
+    #   sphinx
+    #   sphinx-rtd-theme
 exceptiongroup==1.2.0
     # via pytest
 idna==3.6
@@ -40,7 +42,7 @@ jinja2==3.1.3
     # via sphinx
 lxml==5.1.0
     # via metsrw (pyproject.toml)
-markupsafe==2.1.3
+markupsafe==2.1.4
     # via jinja2
 packaging==23.2
     # via
@@ -66,6 +68,11 @@ requests==2.31.0
 snowballstemmer==2.2.0
     # via sphinx
 sphinx==7.1.2
+    # via
+    #   metsrw (pyproject.toml)
+    #   sphinx-rtd-theme
+    #   sphinxcontrib-jquery
+sphinx-rtd-theme==2.0.0
     # via metsrw (pyproject.toml)
 sphinxcontrib-applehelp==1.0.4
     # via
@@ -79,6 +86,8 @@ sphinxcontrib-htmlhelp==2.0.1
     # via
     #   metsrw (pyproject.toml)
     #   sphinx
+sphinxcontrib-jquery==4.1
+    # via sphinx-rtd-theme
 sphinxcontrib-jsmath==1.0.1
     # via sphinx
 sphinxcontrib-qthelp==1.0.3