mirror of
https://github.com/YosysHQ/sby.git
synced 2025-04-27 15:35:51 +00:00
Merge pull request #237 from jix/sphinx-theme
Change Sphinx theme to "furo"
This commit is contained in:
Claire Xen
GitHub
commit
c027aea3db
6 changed files with 91 additions and 77 deletions
|
|
@ -3,6 +3,11 @@
|
|||
|
||||
version: 2
|
||||
|
||||
build:
|
||||
os: ubuntu-22.04
|
||||
tools:
|
||||
python: '3.11'
|
||||
|
||||
formats:
|
||||
- pdf
|
||||
|
||||
|
|
|
|||
43
docs/source/_templates/page.html
Normal file
43
docs/source/_templates/page.html
Normal file
|
|
@ -0,0 +1,43 @@
|
|||
{#
|
||||
|
||||
See https://github.com/pradyunsg/furo/blob/main/src/furo/theme/furo/page.html for the original
|
||||
block this is overwriting.
|
||||
|
||||
The part that is customized is between the "begin of custom part" and "end of custom part"
|
||||
comments below. It uses the same styles as the existing right sidebar code.
|
||||
|
||||
#}
|
||||
{% extends "furo/page.html" %}
|
||||
{% block right_sidebar %}
|
||||
<div class="toc-sticky toc-scroll">
|
||||
{# begin of custom part #}
|
||||
<div class="toc-title-container">
|
||||
<span class="toc-title">
|
||||
YosysHQ
|
||||
</span>
|
||||
</div>
|
||||
<div class="toc-tree-container yosyshq-links" style="padding-bottom: 0">
|
||||
<div class="toc-tree">
|
||||
<ul>
|
||||
<li></li>
|
||||
<li><a class="reference external" href="https://yosyshq.readthedocs.io">Docs</a></li>
|
||||
<li><a class="reference external" href="https://blog.yosyshq.com">Blog</a></li>
|
||||
<li><a class="reference external" href="https://www.yosyshq.com">Website</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
{# end of custom part #}
|
||||
{% if not furo_hide_toc %}
|
||||
<div class="toc-title-container">
|
||||
<span class="toc-title">
|
||||
{{ _("On this page") }}
|
||||
</span>
|
||||
</div>
|
||||
<div class="toc-tree-container">
|
||||
<div class="toc-tree">
|
||||
{{ toc }}
|
||||
</div>
|
||||
</div>
|
||||
{% endif %}
|
||||
</div>
|
||||
{% endblock %}
|
||||
|
|
@ -1,28 +1,41 @@
|
|||
#!/usr/bin/env python3
|
||||
project = 'YosysHQ SBY'
|
||||
author = 'YosysHQ GmbH'
|
||||
copyright ='2021 YosysHQ GmbH'
|
||||
copyright = '2023 YosysHQ GmbH'
|
||||
|
||||
# select HTML theme
|
||||
html_theme = 'press'
|
||||
|
||||
templates_path = ["_templates"]
|
||||
html_theme = "furo"
|
||||
html_logo = '../static/logo.png'
|
||||
html_favicon = '../static/favico.png'
|
||||
html_css_files = ['yosyshq.css', 'custom.css']
|
||||
html_sidebars = {'**': ['util/searchbox.html', 'util/sidetoc.html']}
|
||||
html_css_files = ['custom.css']
|
||||
|
||||
# These folders are copied to the documentation's HTML output
|
||||
html_static_path = ['../static', "../images"]
|
||||
html_static_path = ['../static']
|
||||
|
||||
# code blocks style
|
||||
# code blocks style
|
||||
pygments_style = 'colorful'
|
||||
highlight_language = 'systemverilog'
|
||||
|
||||
html_theme_options = {
|
||||
'external_links' : [
|
||||
('YosysHQ Docs', 'https://yosyshq.readthedocs.io'),
|
||||
('Blog', 'https://blog.yosyshq.com'),
|
||||
('Website', 'https://www.yosyshq.com'),
|
||||
],
|
||||
"sidebar_hide_name": True,
|
||||
|
||||
"light_css_variables": {
|
||||
"color-brand-primary": "#d6368f",
|
||||
"color-brand-content": "#4b72b8",
|
||||
"color-api-name": "#8857a3",
|
||||
"color-api-pre-name": "#4b72b8",
|
||||
"color-link": "#8857a3",
|
||||
},
|
||||
|
||||
"dark_css_variables": {
|
||||
"color-brand-primary": "#e488bb",
|
||||
"color-brand-content": "#98bdff",
|
||||
"color-api-name": "#8857a3",
|
||||
"color-api-pre-name": "#4b72b8",
|
||||
"color-link": "#be95d5",
|
||||
},
|
||||
}
|
||||
|
||||
extensions = ['sphinx.ext.autosectionlabel']
|
||||
|
|
|
|||
|
|
@ -1 +1 @@
|
|||
sphinx-press-theme
|
||||
furo
|
||||
|
|
|
|||
19
docs/static/custom.css
vendored
19
docs/static/custom.css
vendored
|
|
@ -1 +1,18 @@
|
|||
/* empty */
|
||||
/* Don't hide the right sidebar as we're placing our fixed links there */
|
||||
aside.no-toc {
|
||||
display: block !important;
|
||||
}
|
||||
|
||||
/* Colorful headings */
|
||||
h1 {
|
||||
color: var(--color-brand-primary);
|
||||
}
|
||||
|
||||
h2, h3, h4, h5, h6 {
|
||||
color: var(--color-brand-content);
|
||||
}
|
||||
|
||||
/* Use a different color for external links */
|
||||
a.external {
|
||||
color: var(--color-brand-primary) !important;
|
||||
}
|
||||
|
|
|
|||
64
docs/static/yosyshq.css
vendored
64
docs/static/yosyshq.css
vendored
|
|
@ -1,64 +0,0 @@
|
|||
h1, h3, p.topic-title, .content li.toctree-l1 > a {
|
||||
color: #d6368f !important;
|
||||
}
|
||||
|
||||
h2, p.admonition-title, dt, .content li.toctree-l2 > a {
|
||||
color: #4b72b8;
|
||||
}
|
||||
|
||||
a {
|
||||
color: #8857a3;
|
||||
}
|
||||
|
||||
a.current, a:hover, a.external {
|
||||
color: #d6368f !important;
|
||||
}
|
||||
|
||||
a.external:hover {
|
||||
text-decoration: underline;
|
||||
}
|
||||
|
||||
p {
|
||||
text-align: justify;
|
||||
}
|
||||
|
||||
.vp-sidebar a {
|
||||
color: #d6368f;
|
||||
}
|
||||
|
||||
.vp-sidebar li li a {
|
||||
color: #4b72b8;
|
||||
}
|
||||
|
||||
.vp-sidebar li li li a {
|
||||
color: #2c3e50;
|
||||
font-weight: 400;
|
||||
}
|
||||
|
||||
.vp-sidebar h3 {
|
||||
padding-left: 1.5rem !important;
|
||||
}
|
||||
|
||||
.vp-sidebar ul a {
|
||||
padding-left: 1.5rem !important;
|
||||
}
|
||||
|
||||
.vp-sidebar ul ul a {
|
||||
padding-left: 3rem !important;
|
||||
}
|
||||
|
||||
.vp-sidebar ul ul ul a {
|
||||
padding-left: 4.5rem !important;
|
||||
}
|
||||
|
||||
.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;
|
||||
}
|
||||
Loading…
Add table
Add a link
Reference in a new issue