From c9ff26a6ef0b64011b174aae6fa590d6d5e12e96 Mon Sep 17 00:00:00 2001 From: Karol Gugala Date: Tue, 2 Nov 2021 15:10:50 +0100 Subject: [PATCH 1/4] Switch to sphinx_symbiflow_theme Signed-off-by: Karol Gugala --- docs/conf.py | 10 ++-------- docs/requirements.txt | 9 +++++---- 2 files changed, 7 insertions(+), 12 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 6dbc360..4dad59b 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -65,15 +65,9 @@ exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] # html_show_sourcelink = True -html_sidebars = { - "**": - [ - "logo-text.html", "globaltoc.html", "localtoc.html", - "searchbox.html" - ] -} -html_theme = 'sphinx_material' +html_theme = 'sphinx_symbiflow_theme' + html_theme_options = { 'nav_title': project, 'color_primary': 'deep-purple', diff --git a/docs/requirements.txt b/docs/requirements.txt index ec187b5..05aba7c 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,4 +1,5 @@ -Sphinx==3.3.0 -sphinx-material==0.0.32 -sphinx-tabs==1.3.0 -sphinx-jinja==1.1.1 +sphinx +docutils==0.17 +git+http://github.com/SymbiFlow/sphinx_materialdesign_theme.git@master#egg=sphinx_symbiflow_theme +sphinx-tabs +sphinx-jinja From 0ea6ba72cf225ef203f2c2b71a04873776c0185d Mon Sep 17 00:00:00 2001 From: Karol Gugala Date: Tue, 2 Nov 2021 15:19:17 +0100 Subject: [PATCH 2/4] Fix docs build warnings Signed-off-by: Karol Gugala --- docs/conf.py | 6 ------ 1 file changed, 6 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 4dad59b..c32d767 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -69,12 +69,6 @@ html_show_sourcelink = True html_theme = 'sphinx_symbiflow_theme' html_theme_options = { - 'nav_title': project, - 'color_primary': 'deep-purple', - 'color_accent': 'purple', - 'repo_name': "symbiflow/symbiflow-examples", - 'repo_url': 'https://github.com/symbiflow/symbiflow-examples', - 'globaltoc_depth': 2, 'globaltoc_collapse': True } From 56ba7c6670fae56fd5b3730bdf893aa793ebf95c Mon Sep 17 00:00:00 2001 From: Karol Gugala Date: Tue, 2 Nov 2021 15:53:18 +0100 Subject: [PATCH 3/4] Add github_url Signed-off-by: Karol Gugala --- docs/conf.py | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/conf.py b/docs/conf.py index c32d767..77d43da 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -69,6 +69,7 @@ html_show_sourcelink = True html_theme = 'sphinx_symbiflow_theme' html_theme_options = { + 'github_url' : 'https://github.com/SymbiFlow/symbiflow-examples', 'globaltoc_collapse': True } From a7e0a66dcf7e061326ae46a5fe53540ccffe4a3d Mon Sep 17 00:00:00 2001 From: Karol Gugala Date: Tue, 2 Nov 2021 16:18:39 +0100 Subject: [PATCH 4/4] Switch to correct SymbiFlow theme Signed-off-by: Karol Gugala --- docs/requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index 05aba7c..83ae0bd 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,5 +1,5 @@ sphinx docutils==0.17 -git+http://github.com/SymbiFlow/sphinx_materialdesign_theme.git@master#egg=sphinx_symbiflow_theme +git+https://github.com/SymbiFlow/sphinx_symbiflow_theme.git#egg=sphinx-symbiflow-theme sphinx-tabs sphinx-jinja