From: Claire Xenia Wolf Date: Fri, 26 Nov 2021 19:34:55 +0000 (+0100) Subject: update docs theme X-Git-Url: https://git.libre-soc.org/?a=commitdiff_plain;h=882d5b3a965a18a8d6efb24325d65d137fb35928;p=SymbiYosys.git update docs theme Signed-off-by: Claire Xenia Wolf --- diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..c42f473 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,14 @@ +# .readthedocs.yaml +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +version: 2 + +formats: + - pdf + +sphinx: + configuration: docs/source/conf.py + +python: + install: + - requirements: docs/source/requirements.txt diff --git a/docs/.gitignore b/docs/.gitignore new file mode 100644 index 0000000..84c048a --- /dev/null +++ b/docs/.gitignore @@ -0,0 +1 @@ +/build/ diff --git a/docs/source/conf.py b/docs/source/conf.py index dadf507..7db553c 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -4,20 +4,23 @@ author = 'YosysHQ GmbH' copyright ='2021 YosysHQ GmbH' # select HTML theme -#html_theme = 'alabaster' +html_theme = 'press' +html_logo = '../static/logo.png' +html_favicon = '../static/favico.png' +html_css_files = ['yosyshq.css'] +html_sidebars = {'**': ['util/searchbox.html', 'util/sidetoc.html']} # These folders are copied to the documentation's HTML output -html_static_path = ['_static'] +html_static_path = ['../static', "../images"] # code blocks style pygments_style = 'colorful' highlight_language = 'systemverilog' html_theme_options = { - 'extra_nav_links' : { - 'YosysHQ Docs' : 'https://yosyshq.readthedocs.io' , - 'YosysHQ Website' : 'https://www.yosyshq.com', - }, -# 'logo' : 'logo.png', - 'fixed_sidebar' : True, + 'external_links' : [ + ('YosysHQ Docs', 'https://yosyshq.readthedocs.io'), + ('Blog', 'https://blog.yosyshq.com'), + ('Website', 'https://www.yosyshq.com'), + ], } diff --git a/docs/source/requirements.txt b/docs/source/requirements.txt new file mode 100644 index 0000000..954b454 --- /dev/null +++ b/docs/source/requirements.txt @@ -0,0 +1 @@ +sphinx-press-theme diff --git a/docs/static/favico.png b/docs/static/favico.png new file mode 100644 index 0000000..3f5afba Binary files /dev/null and b/docs/static/favico.png differ diff --git a/docs/static/logo.png b/docs/static/logo.png new file mode 100644 index 0000000..8e5a507 Binary files /dev/null and b/docs/static/logo.png differ diff --git a/docs/static/yosyshq.css b/docs/static/yosyshq.css new file mode 100644 index 0000000..e0118a8 --- /dev/null +++ b/docs/static/yosyshq.css @@ -0,0 +1,35 @@ +h1, h3, p.topic-title, a.current, a:hover, +.content li.toctree-l1 > a { + color: #d6368f !important; +} + +h2, p.admonition-title, dt, +.content li.toctree-l2 > a { + color: #4b72b8; +} + +a { + color: #8857a3; +} + +a.external { + color: #d6368f; + text-decoration: underline; +} + +.vp-sidebar a { + color: #d6368f; +} + +.vp-sidebar .toctree-l1.current a { + border-left: 0.5rem solid #6ecbd7; +} + +.vp-sidebar .toctree-l1 a.current { + border-left: 0.5rem solid #8857a3; +} + +.injected .rst-current-version, +.injected dt { + color: #6ecbd7 !important; +}