DOC: Switch to sphinx_material theme

spatialaudio · Aug 14, 2024 · e49d52d · e49d52d
1 parent ae3c9d9
commit e49d52d
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 0 deletions.
diff --git a/doc/conf.py b/doc/conf.py
@@ -138,6 +138,27 @@
 html_favicon = 'favicon.svg'
 html_title = project + ' version ' + release
 
+html_theme = 'sphinx_material'
+html_theme_options = {
+    'navigation_with_keys': True,
+    'nav_title': 'nbsphinx',
+    #'color_primary': 'blue',
+    #'color_accent': 'light-blue',
+    'repo_url': 'https://github.com/spatialaudio/nbsphinx',
+    'repo_name': 'nbsphinx on Github',
+    'repo_type': 'github',
+    'globaltoc_depth': 3,
+    'globaltoc_collapse': True,
+    'master_doc': True,
+}
+html_show_sourcelink = True
+html_sidebars = {
+    '**': [
+        'globaltoc.html',
+        #'localtoc.html',
+    ]
+}
+
 # -- Options for LaTeX output ---------------------------------------------
 
 # See https://www.sphinx-doc.org/en/master/latex.html

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