DOC: Switch to py3doc-enhanced theme

spatialaudio · Dec 14, 2018 · 90ca2c6 · 90ca2c6
1 parent d28ce81
commit 90ca2c6
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 0 deletions.
diff --git a/doc/conf.py b/doc/conf.py
@@ -4,6 +4,8 @@
 # Use sphinx-quickstart to create your own conf.py file!
 # After that, you have to edit a few things.  See below.
 
+import sphinx_py3doc_enhanced_theme
+
 # Select nbsphinx and, if needed, other Sphinx extensions:
 extensions = [
     'nbsphinx',
@@ -128,6 +130,11 @@
 # -- Options for HTML output ----------------------------------------------
 
 html_title = project + ' version ' + release
+html_theme = "sphinx_py3doc_enhanced_theme"
+html_theme_path = [sphinx_py3doc_enhanced_theme.get_html_theme_path()]
+html_theme_options = {
+    'githuburl': 'https://github.com/spatialaudio/nbsphinx/',
+}
 
 # -- Options for LaTeX output ---------------------------------------------
 

diff --git a/doc/readthedocs-environment.yml b/doc/readthedocs-environment.yml
@@ -10,3 +10,5 @@ dependencies:
   - matplotlib
   - pandas
   - sphinxcontrib-bibtex
+  - pip:
+    - sphinx-py3doc-enhanced-theme
diff --git a/doc/requirements.txt b/doc/requirements.txt
@@ -5,3 +5,4 @@ numpy
 matplotlib
 pandas
 sphinxcontrib-bibtex
+sphinx-py3doc-enhanced-theme