DOC: Switch to sphinx_immaterial theme

spatialaudio · Aug 13, 2024 · de68731 · de68731
1 parent ae3c9d9
commit de68731
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 0 deletions.
diff --git a/doc/conf.py b/doc/conf.py
@@ -137,6 +137,28 @@
 
 html_favicon = 'favicon.svg'
 html_title = project + ' version ' + release
+html_theme = 'sphinx_immaterial'
+extensions.append('sphinx_immaterial')
+html_theme_options = {
+    'palette': [
+        {
+            'media': '(prefers-color-scheme: light)',
+            'scheme': 'default',
+            'toggle': {
+                'icon': 'material/toggle-switch-off-outline',
+                'name': 'Switch to dark mode',
+            }
+        },
+        {
+            'media': '(prefers-color-scheme: dark)',
+            'scheme': 'slate',
+            'toggle': {
+                'icon': 'material/toggle-switch',
+                'name': 'Switch to light mode',
+            }
+        },
+    ]
+}
 
 # -- Options for LaTeX output ---------------------------------------------
 

diff --git a/doc/requirements.txt b/doc/requirements.txt
@@ -1,3 +1,4 @@
+sphinx-immaterial
 ipykernel
 numpy
 matplotlib