From 5426bee107614c302bda88abbf903c3fd5a149ad Mon Sep 17 00:00:00 2001
From: Krystine Sherwin <93062060+KrystalDelusion@users.noreply.github.com>
Date: Thu, 9 May 2024 13:04:30 +1200
Subject: [PATCH 1/3] Use furo-ys
---
docs/source/_templates/page.html | 43 -------------------------------
docs/source/conf.py | 29 +--------------------
docs/source/requirements.txt | 2 +-
docs/static/custom.css | 19 +-------------
docs/static/favico.png | Bin 33435 -> 0 bytes
docs/static/logo.png | Bin 15938 -> 0 bytes
6 files changed, 3 insertions(+), 90 deletions(-)
delete mode 100644 docs/source/_templates/page.html
delete mode 100644 docs/static/favico.png
delete mode 100644 docs/static/logo.png
diff --git a/docs/source/_templates/page.html b/docs/source/_templates/page.html
deleted file mode 100644
index de334e7..0000000
--- a/docs/source/_templates/page.html
+++ /dev/null
@@ -1,43 +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 %}
-
-{% endblock %}
diff --git a/docs/source/conf.py b/docs/source/conf.py
index e18817c..68831f1 100644
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@@ -10,38 +10,11 @@ copyright = '2023 YosysHQ GmbH'
# select HTML theme
-templates_path = ["_templates"]
-html_theme = "furo"
-html_logo = '../static/logo.png'
-html_favicon = '../static/favico.png'
+html_theme = "furo-ys"
html_css_files = ['custom.css']
# These folders are copied to the documentation's HTML output
html_static_path = ['../static']
-# code blocks style
-pygments_style = 'colorful'
-highlight_language = 'systemverilog'
-
-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",
- },
-}
-
extensions = ['sphinx.ext.autosectionlabel']
extensions += ['sphinxarg.ext']
diff --git a/docs/source/requirements.txt b/docs/source/requirements.txt
index 0e4756e..9b32c0a 100644
--- a/docs/source/requirements.txt
+++ b/docs/source/requirements.txt
@@ -1,2 +1,2 @@
-furo
+furo-ys @ git+https://github.com/YosysHQ/furo-ys
sphinx-argparse
diff --git a/docs/static/custom.css b/docs/static/custom.css
index b23ce2d..40a8c17 100644
--- a/docs/static/custom.css
+++ b/docs/static/custom.css
@@ -1,18 +1 @@
-/* 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;
-}
+/* empty */
diff --git a/docs/static/favico.png b/docs/static/favico.png
deleted file mode 100644
index 3f5afba76569d0610c2f7efead58417c4c9ab050..0000000000000000000000000000000000000000
GIT binary patch
literal 0
HcmV?d00001
literal 33435
zcmb4rcRbbY|Nq-TN+OYL#a#%=D0?P~P!uQgWTYq~dmpLDOt!3&RMsg(=823lBZ_R<
zdvAWP_i=wdpYOlF9*_IJJJ)<&ukn11>w4c$uWG3sqGqK=5aiJ1ODZ}DLP0?P*}o53
zCQsxw!+$6ol`mi44}ZM&TLdD=apba!(sj4QsUFP`qq{DrMjW}{#vhSlef*C(Vi+US
zg*WJ^p|@~H$oD1wApCfGh30B!{k+-ff_6IFj;1{B0+G_Q_QCk+&|~jzx?Abli3)A-
z-ZXK$wOoY7`(Yw${-LZg_Y_HcZuMGSUv$w!>0^+^BCjv^V2Q-c;=SS$Z1nmo>ADcN
zS=XjxWI){i#~-`r>E!6}o)0&BQqDURA7!zL7YRPKV=>zn+9!|{-2R4$f$rYBXL
zKPMito9Ws9Rwbq8A81cnz{3U|AZDvpvvQ+CFH&0}Y(GqXi4urUj<<4HF6#~p)E-$~
z?)OyP4}3`F?RfA1BUCnL)X>N~SIWkx*w=M2@1ocJjm86lup!pLrv1y92m7oFr@lic
zhyG~9yn_lKAx?%D#Esw{-@oo@7;)38#*L+KHn&NBt)O{!XKm8bOL(JdZ@$uG`;ObQ
z4=-5qEPeX^J#NG7w+Xf=T37&S_@!FlYb6<&W*MtbPanTN|FMEMvw8ms=*kLQw)S1w
z`q^G|=ULuBV_AuUJ64=rpqkX_)NSB=wm7-3yD228^(HrWg4YI#E;gP=Ftz0t>^kMa
z=^GKB&6k_}ZMyXUR)`us&)D11k{sHgaGLT{VybNIy?W#9S+sj|L{LiO9E3&Rr011t
z-u7XnPl;~&Vomsp3QpQ0udB~ibfSSdx@kfF|A@9pX;sRP5=L+k^f*Fn|2lB6{4tga
zeSnH^P+NU8b#scu{FpykGun24=anq(#Wp=S!E$4Kf7U)qCYYH2J1^o(oB#RQ5|7M~
zagPFpGaUXix;PMyqQ?EHsdkaTo-BUa(
zs$QG=Cy}%lQzz_|J34<%;F`%rmD?c_nVUUqzOQdEVqv?MBf=}jmNi9AF`vKd)^~qC
zvPT3FF?7?eztoA+=InVW5OZ9OJY`pw(zom3So>pfh)#?n+h<|H+axtCY0
zaDO46i#OKb;tSgT>`!8-#O%pujq2wUL=`XTv#rvS!&eCxU$s0T7(jH8H-zaI5sWqb}})
zqJAmsIrAw0Qtt;syMuEh86|3w9m~lGuXJgVADk)8CGzxXc$?cr263f
zpz$dfRH}EBer#+!S9Fu21Rnt#XxCg)wEghGv%*j&VAK7VrNs%S%xtoy=Q_hyb#NaJ
z$Lq6md5s?Pl{b)V5T>3pjs_6tZj}CFn}vDEGgwZ|3B0ADMa?}x
z+}I{1Pkut&i?qvfO?=|=Yo}Ov_7?fw-PzaJu;SHwQ_26%*5+_FBetQj?N;#j%-B-N
z&}C3dbt^ELVk<{0UkTAq8lza}c#ZPIAzIgPA`+SwH>9f!EkhD)-0j^aZH=YD-L`Oi
z&pi1(j+N){eORg*)J_#_Ic)X&?NMNpDJr3HK7fvr``0&Jqx9=7L!K4FT3l61u3;Xx
zuV_D6e@r^Qj;P0U-w}EU{9-*2fumo
z%^ue_o(e_3>S(zQLT^xrZSTVB_N7}Ai(p8O1=ptU^XGoIUU;XA-NH~Z>Bm^DUmK^<
zU%2;rZp>cCW}OU4ttCOib(5p99c6O|KRO}B(;ykGoMF?bCOGM$r^1G*!g^$@2(W&*
z3-IfOtXy4=R%}+nf3RPA-}C?lll}wIkap`DF;_Y}pNXfS{!4WLh1Ls8$qVo0Lg*Ky
zVf*}t5-K!io2c5Xn2{mG3BycURf&bQ<6<@Gd2^zmV(Na?=^P|wRv*O%hID>AOE*=G
zLGbM^JmGZQRhv68-$Fk8+3y~Y3D)o|wjT1&t&e+h1a{Nw7-`zcS$JOtTZvLK#dfIZ
zrHcs~)$rvE9}6g)m~OoW^sjgR?#$#dFL9#nt!6&ar;Bso4~X<&^-iE~?)G-dE7z5V
zD9PUWMf;A+?U|^iFC{EIe=Vs6&sa&0^;~OW|9fA85rZfeqP|sR|LmkpCG!bkK0?v!
zHz{gTR3Em-sBi1yS?-Ytze%2xab7oWm{m7_i){Mm5);f(z@}^I#tq-lvIr?*n_c
zw765jV-kfmW!JLSpadaS=Zs2}L=1R)s+}7U;{%Gv=Jd)qk`26s&DpDDuL7?XW$w>R
z&E9^4d0iDkf8-@`@FA<3gzvSQOXvpEc{iu+)M{MD*^QD!lmR*a{CLfop7z4-%~#;P
zUgz7DPiBX0*^TIH_Fuy}*z#WR#g(=NADPrEBdPvU=WSc%?o%MspHumeB!(D{5{eO|@thLg<72>vf0x
zk7b~nr+0y&hSGT6)sGUX^Z|*T37!8^e+|_hoqN|kWnfWnSX9HW+Eb2;Yl(5_Bg$IB
zRfrh`scyzLeHmoonG&XCnspXszn(7Ul#D71lNrc|!=hUt$$$8)>TgqO!KRn<0adbm
zfG@Zl@D11gj_0sZZB{eiQs5`JWmH|3J0#)O5RT3r8S(Hjzw1c{%ksjq=h?Bn@^)f~w9SYC;S_2=HB
zL9(c;#%O9%2>nU`CfF3`MM$+e*-?h#L+YV_S(iRtnj}(Leib*r@7TncnU)8@nt;}m@0lIU
zUsr|<3ob?jsx(0$REr<|_hPd;R+7KYL2P6FNnK
z;L_0`FXodYOZ*ugLuYEia&s?2wWz8{gFkqaGaO(yOt&ETY`P+Y`^;|sNI=`~q6#zD
z)T59e-_Fi*Xj<34BSWzKFWR^7M&7zBqi+^sU%*cY+&|=>6d@wVGNLrjjJhi@4!#Aa
zU%di34cC9D>*DC?Yp7&SntQk{w)LP)#c|sH{ZOXgaPf9S$9wXNV?jE&TV90VeILBt
zCUbZ?5X7nLc0mOMx9N@qY1^+Knm-As`#qljl7l)P)Ib5!jGmO~3o1v3j=wsZPOMzR
z#ahnDC;!Ytm+$9BWfqySI#p)YE9zL!JYcPZTTYz+GGp_^eb!#*4-5D#E2CyR7cta8
zGr#Q(=x%%IzSvaHTunNuHVnE`1|cG^*ijlmtr~;z{S7IY%+Z9i@`N?o4S%IDsM=sm||)`p#0mJ|hLJj=_{R`nufCMFD=uHAy!>LJV&ytie2k>Y7h@q<`i~Bn5LSaMZ7TDBy#Llp
z#y9j|pZ4XU_`GxCd4-)Hu_>~GAVs_nngN*GZ(JN_Uux-`8|m#yS-XU6um~-_vhgzlL=qUB*Sh%L*mF_8&-qXe2ZVk699=|+vSxx}-8lMcIdjlandQh~DGwbL8Q)RNlCNBKk{IYP;
zc?sXOVP0)@H8KR}j4E#YT@1cMQZATlXS^qrH{H?xoEC05Wc~|hJ#$h~{9y!7*#)p3
zrJvt;)=W>DTt9<2!7}787b~*8Vqh>qix9iBZ&0OOnmu81t!z~BSE1AS-&Twi?0M9^!|A7BU@GpXsmuhUtcDqw&C7+eA6RrdGausr>
zLi#`ctEB3q_|>~!oHMeNdfLofe?vvz@cL(I)B^OpfDA8*1vuO94W86wx>Tk+mq4&;}!LUe8wVicZ!>dgw`0q0ZK1I{XC<@A`P$
z(&wTo7%(?|uF!AJrx8_k2;zX?{Jyh8Cbxg5t7ll$xRIjFFT)_MaN!_$M12RkYN-$LDbxJx2!8=__%Fs6ItwS1t%+h
zf?jtT-DI|Xerzyc-axiT32E3Kp2<$VZWA^Cq{p!q(yc_Db=1o1S^c*SdmR}j5SQzJ
z8SoxZfIpp92bV298bGc^ekIi_X
zB%;`y4eEJm_TbHvQUXc%U|n1`;od%*bg`EEEFYHF^vZNm77f#gy0rN_=v^XZo^9$J
zX+(p&IaI?F3HfvfkYmAh
zBWS&xLNGQr4pDK%h7qa1F(=V1Lbik;g4dD(DZYOXnMYIaB>zPqMsUc#;bzU$kH!rx
z(vaSoCKC>pj!T5reex2nK^PlK7A}ixkmYb`PuxT$B}j4?SB|X{HbfOpbNHc)q_P`)
ztQ!=sDz)NbLWtG|5QF;Dr1>u?lMpuLzO=Gm!NY`0o4Hu_O~_jHI?zN>)3Jp|Vh|jz
z8XTtq!lM^AtOn4tV5QJ%#hVwMWAPyct@M&ylpR6t(liS8SZdPjS`;|0!17uQ@)ukm
zV{EDuEv>_EvXVNhmSxLhS$co{kck(8*!qRp1VY(Cjpma-IrFZp+#*AqdQ}SwBgeV<
zHZs3utXy)%V{9HLGIPDAK<7)NMJ2TnK$g_kA&JpV#7$73OOa@dzZB^W4!cLZ?)N$A
zOS6_&er0Yuj5C+Mfaw-PzlDdztGWwNVac3-zb&ImH4uMmt*pfblxlvg%0oa_>gDT@
z`NCh_M&w8fCF;UxE60w@{<1KC^=_CEE5Hq!u44j7fMQn@#A2R*-%*9nQF{`)wEPNA
zw_;qoUVh7><1MhcLxvbwr*%~@u=M7B(fF@vPQxPo_Bz_3bgie+W9C2qq2yNLCsL^g
z0(v;mKh#R!f0U&y5*)ob#2sZ&eEa!#ybKOn)@q>}498R+l3M(hMAVLmu
z6`x4}keV%OUJ5p>G1}kAh~;n$E?+4^JZvykdUi{RyN=B`*(DX{~ej9U}WDfCp7tb=Zrem{^!
zDx~52d(VRL0kE&R5@T
z>t_X`I@YSIjNk=CrS~t!*6cStsX^6m22sJC%(0vRNRpq^q1`hog
zNRLSn6>c(6bL9!;OxD|w&a@ZHNoZ75T$$}pa0_kj&wfdqcm^uwGel?wSfS%x&PQc>
z=B)Jo;8>Ql#)z>0=1-8-lue3m0+(qBrr>cLqB*omun$o*
zWZ`&pGB3FJC@{!D@?FM&+gb03#wOIkLxhwX3S4}UUiD8lEE&kYap*$D|KVTP*RkVK
zAFfSzUN(-yWb!1`g=<*h)4wzOdN#@nBKTt=w8}~>Ht9S|NtjG>U?HDqw};}a#n+fW
z5@bm7XUfh5rW3A@aI7XQjxn)2*hc
zRrHd`dno)2m_KDP_JrJx2c%65VzZcfV_eiC9encH9@-mi()AMS0nJS_aC)O%iiKa!OI7=+S)|FC>!Y%0Y8=)o^7}k;>xAFNok5pYsz8GSRacKl3l$
zMk`IDkn;tNrul2dUQja%x4R8T48>$VCI!b+D}IjFdmfyO43VDn@NxVzcHHR_8f1H?
z5v^ZFzI<$Ne}ZKwa)9_z7fFpo=|`&5|MUkG
zq{yAUSV*j91t%1a$-GFCp-3D#h)6LQjXdh!0xxo!IJ1VY;R@=$wH)LcsX-~y@ek?A
zUuDwsm&0nnnIlh?&D{zMIf6m%qm>IQ5Bo!zuh8=NOJPRr{pTiYXZ6t?nQnq>Ck51J
z6-fTokTRbFR8unXXPbQp^GGwg^pRhSY+$hu6WpW)l3vm=VugOtB$hwCC;~E%0+j+s
z;pv0D2oyiYWS&IT<}upEh*pC4v6KLlf}iKL9@qe(W1v9G$Rt&1hH3;gYH;x)5Nly+
zJP9!upu5jR*W`;R%A}b4Bo0a*pcR0_R_o#l6qAS5(!~^oNxecS3%P##7uZv0oj)tT
zzdo|DY2dX>=`jRbgl1WyrL%Yw0+r1VM(krWCXEXS7-oIL`w}54lep-#z~)g&TKDLR
z6LU`MW6S#gYC6`~|K3Cc!IQz`D~!;=9d(JhtHnfJx2NTTl@M-3$8%o4&Y%|4AW$EVAAK@F{Lals2)g@8ofk2Q6p<;tVHXS8
zfm1Dd`0=XKb4TES%6>P95a$JCI=@W+2sVKJwD{4j7vgj9AJ!C+2W)M4%RdvM)BXfFaEOooMn%RxVlQ5#~
zcSHFJT}{h_&c8XpsQ&DQpHJ`iXD8e{l`fXWO4;$812UwdmlR#X=1!vQ-Dd!(?xc_u
z;0@^AbaX^sD~nzz#^zh=j=)&hJr_Sab0J+n|-T6%WStuSO960^DQ?EHk7DM3))
zGk2e$rZIcy4VO-(%00Sj@s0u^K;Vy5;vLox37&h)gluID9Cn
zff*uvC$%>RvfOoWLf5){DSM(t{!?frc34`hI)~S$st_cuvaF$n7t(q%nZfwFp3|_LIo*{??E2QDKDBK*NLca~J6JlxwE`
zt$h&ONYzLC4eFwYiP2i5F=o3*vz}*#pDJLxNQSHKsT-2+;iffGf@~&p)0QWZoU-Gi
zqzercikGI(!7haFD0%4hAX(N!UCIu2K0*v}M*u6w@?m)OJd&03@`n=6MD&V9qaViR
zK*B(OS}O~F-R8+>8$esVX1KrO6-|soMqW8E3>d-OS19%iD%Px7NJ7fH4>_vc1u$K=Kw-@Z~*N|Gz~Bqh3-v68y)nnozg>
zoe_J`YWL`p5`+7u47Wqmf8GK>u|xxW(wR}XU$%f-3|ibd%Y>%l)07>UPG3s7=OWT5
zAS6MW9qxGe%xy9z>%8Jzt|H98{gEP2?Y?if4{>TZUUh*FH?W7T^{|@-?4}JRHt}~o
zMidCg2S9JOX|k9TV!TkBjmOx$oT_-(i{^k-s)vzOa#GrV%Rz>~sL5BK3+i!v#Z)QW
zGH(&}nzc|-ng(|$BbJ!BFNRyJ#-`m*!ST#x7^Qu|ozlC5#<=Pba{m)N4!Av{HO{VB
z;dQvS_@M@{wyu--LvgGiWc=TN4=-V}@U!X^ZhT+Oeql{mApWkO%#zVzntVJFjdp390!}c^6LS)VsI7&rFBjN)K`P(E78^Q!;M5&(c4e~DMX1(
z{v1(TP(7{4Px3(mAI>QG6(B37WWx2QTtNvXz9UzELy8-WR*3NBGB4>2}mQxzDK
z2oY&;tf!&CR7C?K8zcdPQv}9_9_@{744XGY_^jY{!_$1veRuqqtbUy2BaAdqUGKl2
zaLZ%jAVP`lrpmSb6y(H*XdQ%9-Y2q2`Z+`8LhAd=Hhln=NVw887&wF+{D_8b
zX{VFO`$M~fJZ`}VYgRSH&k;>esBAA_@RTeTx`uF;_=_{g(ufJX`nNF0AZ{Lbz4Dh5
z8EF8?929&|!3^Y~R||2uRA;^`yCQKiz%{KptN_PL4Iph{`rKkB@ubBSuD3tr_@3kSp?uq33brBG~Px7VW1`h53xIs?KHEwZtK`n00c
zuyW4&@vx*yXBI#8jF+XDoSYA^^qEFj
zIuZq}mZNY`Nwzyz{G{rb75
zflZoz=eSJliQS11GTlyxZY3!%7%|MU^2o}jHsMEhC~
zJt97|$a9o@w|$lz{|gi>i!r#n`J$gQCF;79H;`a)2ofleJ8bBh<`J7vl*sA-W20qC
zb}&Z7(<`$V4Y<212VHPS4^<7stzN?!SI3+C5C_ji6bd;};jIL1sr0TzhF+YReMu~S
zc;#TX-$|4hi1+Z-)5HmNDvRC=e$MAiaKs02n}}wh;JnjONmhS7LKBVr(No?Zk09Ak@|%TjC}v_d=hk`
zN~J@g%L2WQz)2+%J&sX!oLuYQAJswQSm?A5!RE8M-vixaLj%N@P^O5rKW|@l@+!9G
zH>j;%=YQY;i9rj5fc1K?I`iw#*Hb0oKv+xg0^Wa5RTk>vjFry=y+Y4OkW8coNsVQP
zaDi^YjDylpRyZ3=oqrKZW&z835E`5nhN;`PBR2o=5zfFVVD9vD%?`L6dT5B~Jp`3)
z<|p(j`#E2;GP$ByZxK?#@f9t#+1~(X{SLZQENkv$OJ5zV@WV_#6m`sY+K2x&eB91(
zj8^g2Id^L~lPA~L5B_3ysl;MQ;eS%2QD)SihdZw;lhVk(f#yny&wA2|v0yOsPu;yz
zvy+9Lc9VR!zFDQGDH?YBxQIGzJuzjyNYlH1^>kjm?B-@n=G}!w*If=PZSKKuY(4{%
z3Ofst0gKuc!G#ckB*^CEIUU9`U6P?!MX8(Iz
z?TNdkI>!&)7T)!^y|{thl@zUA)VMm5v9qb2TDpyFC%tg>ofkge=>My{s_M