3
0
Fork 0
mirror of https://github.com/YosysHQ/sby.git synced 2025-04-04 13:54:07 +00:00

update docs theme

Signed-off-by: Claire Xenia Wolf <claire@clairexen.net>
This commit is contained in:
Claire Xenia Wolf 2021-11-26 20:34:55 +01:00
parent 5d19e4641a
commit 882d5b3a96
7 changed files with 62 additions and 8 deletions

14
.readthedocs.yaml Normal file
View file

@ -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

1
docs/.gitignore vendored Normal file
View file

@ -0,0 +1 @@
/build/

View file

@ -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'),
],
}

View file

@ -0,0 +1 @@
sphinx-press-theme

BIN
docs/static/favico.png vendored Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 33 KiB

BIN
docs/static/logo.png vendored Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 16 KiB

35
docs/static/yosyshq.css vendored Normal file
View file

@ -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;
}