Docs: Switch to furo-ys

docs/source/_static/yosyshq.css

@@ -1,40 +0,0 @@
-/* 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;
-}
-
-.wy-table-responsive table td {
-    white-space: normal;
-}
-  
-th {
-    text-align: left;
-}
-
-body[data-theme="dark"] {
-    .invert-helper {
-        filter: url("data:image/svg+xml,<svg xmlns='http%3A//www.w3.org/2000/svg'><filter id='f'><feColorMatrix color-interpolation-filters='sRGB' type='matrix' values='1.47 -1.73 -0.467 0 0.867 -0.733 0.467 -0.467 0 0.867 -0.667 -1.07 1.07 0 0.867 0 0 0 1.0 0'></feColorMatrix></filter></svg>#f");
-    }
-}
-
-@media (prefers-color-scheme: dark) {
-    body:not([data-theme="light"]) {
-        .invert-helper {
-            filter: url("data:image/svg+xml,<svg xmlns='http%3A//www.w3.org/2000/svg'><filter id='f'><feColorMatrix color-interpolation-filters='sRGB' type='matrix' values='1.47 -1.73 -0.467 0 0.867 -0.733 0.467 -0.467 0 0.867 -0.667 -1.07 1.07 0 0.867 0 0 0 1.0 0'></feColorMatrix></filter></svg>#f");
-        }
-    }
-}

docs/source/_templates/page.html

@@ -1,44 +0,0 @@
-{#
-
-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 %}
-	

docs/source/conf.py

@@ -8,37 +8,13 @@ copyright ='2024 YosysHQ GmbH'
 yosys_ver = "0.46"
 
 # select HTML theme
-html_theme = 'furo'
-templates_path = ["_templates"]
-html_logo = '_static/logo.png'
-html_favicon = '_static/favico.png'
-html_css_files = ['yosyshq.css', 'custom.css']
-
-html_theme_options = {
-    "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",
-    },
-}
+html_theme = 'furo-ys'
+html_css_files = ['custom.css']
 
 # These folders are copied to the documentation's HTML output
 html_static_path = ['_static', "_images"]
 
-# code blocks style 
-pygments_style = 'colorful'
+# default to no highlight
 highlight_language = 'none'
 
 # default single quotes to attempt auto reference, or fallback to code

docs/source/requirements.txt

@@ -1,3 +1,3 @@
-furo
+furo-ys @ git+https://github.com/YosysHQ/furo-ys
 sphinxcontrib-bibtex
 rtds-action