-
Notifications
You must be signed in to change notification settings - Fork 74
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' into krys/scy_dev
- Loading branch information
Showing
15 changed files
with
225 additions
and
162 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -3,6 +3,11 @@ | |
|
||
version: 2 | ||
|
||
build: | ||
os: ubuntu-22.04 | ||
tools: | ||
python: '3.11' | ||
|
||
formats: | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 %} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,28 +1,47 @@ | ||
#!/usr/bin/env python3 | ||
import sys | ||
import os | ||
|
||
sys.path.append(os.path.abspath(f"{__file__}/../../../sbysrc")) | ||
|
||
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'] | ||
extensions += ['sphinxarg.ext'] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -16,6 +16,7 @@ formal tasks: | |
|
||
install.rst | ||
quickstart.rst | ||
usage.rst | ||
reference.rst | ||
autotune.rst | ||
verilog.rst | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,2 @@ | ||
sphinx-press-theme | ||
furo | ||
sphinx-argparse |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
Using `sby` | ||
=========== | ||
|
||
Once SBY is installed and available on the command line as `sby`, either built from source or using | ||
one of the available CAD suites, it can be called as follows. Note that this information is also | ||
available via `sby --help`. For more information on installation, see :ref:`install-doc`. | ||
|
||
.. argparse:: | ||
:module: sby_cmdline | ||
:func: parser_func | ||
:prog: sby |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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; | ||
} |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.