From e49d52d51be9479ffb43d586b4827bf0e2e92165 Mon Sep 17 00:00:00 2001 From: Matthias Geier Date: Thu, 5 Dec 2019 18:52:11 +0100 Subject: [PATCH] DOC: Switch to sphinx_material theme --- doc/conf.py | 21 +++++++++++++++++++++ doc/requirements.txt | 1 + 2 files changed, 22 insertions(+) diff --git a/doc/conf.py b/doc/conf.py index bbb90390..fb711092 100644 --- 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 index 3c83291b..72461182 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -1,3 +1,4 @@ +sphinx-material ipykernel numpy matplotlib