DOC: Switch to python_docs_theme

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

Hide file tree

Showing 3 changed files with 19 additions and 0 deletions.
diff --git a/doc/_templates/layout.html b/doc/_templates/layout.html
@@ -0,0 +1,7 @@
+{% extends "!layout.html" %}
+
+{% block footer %}
+<div class="footer">
+    The original theme has a bunch of hard-coded information here.
+</div>
+{% endblock %}
diff --git a/doc/conf.py b/doc/conf.py
@@ -137,6 +137,17 @@
 
 html_favicon = 'favicon.svg'
 html_title = project + ' version ' + release
+html_theme = 'python_docs_theme'
+html_theme_options = {
+    'navigation_with_keys': True,
+    'issues_url': 'https://github.com/spatialaudio/nbsphinx/issues',
+    'root_name': '',
+    'root_url': '',
+    'root_icon': '',
+    #'root_include_title': False,
+}
+html_js_files = ['sidebar.js']
+templates_path = ['_templates']
 
 # -- Options for LaTeX output ---------------------------------------------
 

diff --git a/doc/requirements.txt b/doc/requirements.txt
@@ -1,3 +1,4 @@
+python-docs-theme
 ipykernel
 numpy
 matplotlib