From 74a0d44f447430b0b9975f74b02b5695e5ca5e8f Mon Sep 17 00:00:00 2001 From: Serhii Snitsaruk Date: Fri, 12 Jan 2024 23:42:32 +0100 Subject: [PATCH] Doc fixes --- doc/source/.readthedocs.yaml | 8 ++++---- doc/source/conf.py | 6 ++++++ doc/source/logo.png | Bin 0 -> 7978 bytes doc/source/requirements.txt | 4 ++++ 4 files changed, 14 insertions(+), 4 deletions(-) create mode 100644 doc/source/logo.png create mode 100644 doc/source/requirements.txt diff --git a/doc/source/.readthedocs.yaml b/doc/source/.readthedocs.yaml index 61585fa..7df6d86 100644 --- a/doc/source/.readthedocs.yaml +++ b/doc/source/.readthedocs.yaml @@ -16,7 +16,7 @@ build: # Build documentation in the "docs/" directory with Sphinx sphinx: - configuration: docs/src/conf.py + configuration: doc/source/conf.py # You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs # builder: "dirhtml" # Fail on all warnings to avoid broken references @@ -30,6 +30,6 @@ sphinx: # Optional but recommended, declare the Python requirements required # to build your documentation # See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html -# python: -# install: -# - requirements: docs/requirements.txt \ No newline at end of file +python: + install: + - requirements: doc/source/requirements.txt \ No newline at end of file diff --git a/doc/source/conf.py b/doc/source/conf.py index 13047d4..fd76e11 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -33,3 +33,9 @@ exclude_patterns = ['_build'] html_theme = 'sphinx_rtd_theme' html_static_path = ['_static'] +html_logo = "logo.png" +html_theme_options = { + 'logo_only': True, + 'display_version': True, +} + diff --git a/doc/source/logo.png b/doc/source/logo.png new file mode 100644 index 0000000000000000000000000000000000000000..0533077b0fa431e2e85311444578ed45d715cf15 GIT binary patch literal 7978 zcmZ{JbySqmxAqx^7(lvvKtLsw?nYWVC8SGQT52Q(Bvq6~LTN!t99mLRI;4?~p=*#k zzx#dbu66&o>wVXI&N}bjYoFZbdG?Og(NZBIpeFzT5UHs?)&l^7sRBb7F6R4LSt1Qn zz-?9aGy!>DzfGbQBViN#gJ^;3@0Fd|y0F7tX4_ztD4?G_=O(ncd$Q>Gpm@`hg z8>R`@MnmN>xc$$Q*Zk!z0L%nxkL3*lX7?=o4cObBOw;F=*H^kZGPq^0(e$sWWd*E&q;HyQ~x+j(s!gcDq0S))Qsg@$aYb zPRoLkOyJdSQ=)u`)+oOjjPfNZK;OlK*kFd!m^VwZe2%{x{l2LNnRGh@v9=u}W|lDu zYHUI)X=)N7LvMa0x|rD8Pwc!C-16ttivLx#N;2vnlY(k}6pZPB+6&fEZ&b+U{$8u^ z+V=~f*1&%tBL4yWFdFSeI5B6K%Wo|i1GQB1SEd1e z>kGjvmZ=uEfu3JS)&|P6kfff%?Ng3UxLq6^+C5KR53qS#F+qA+B5idr#va;S?fE!D^QAruM^BH)#2ZwB5!3mfNJWRDL{o1 zK5D%z_<6VHtARmNEe^=HU3vJM*77at7Ksfo!|uiQ^r&#&->*oYZuT%yw_fh*nG}Px zkI=JyR?6l8Ch}HC!=rd`wbXbWmqmEW*uhkHL;vy(UedD$c5D+G9C%f4-yo7@#7!<0 zvn5PKwPopW-?8@@_Wqo+WQW`&)*>ceZ{2P0(c{hg@#AVR)t)>4PYC*alOWnoy$Umj z_PB7$>4z|Ge;7XM6IHcK+^5M*=&Lg0uPyQka*~=!t0(g?a&)fZ#e5TbP4PW@-+MHW za9n!C+WU-2fxOk^&`|ex(aOEv8)GO|@xKyhI)8NdbvFBiYzAU=@v(X}X0FU%XNZPr zw=yqT!mvAH&q?UWa$1~sh6vd4tm{Ov5pOW-%!Cz00kH2V;pP>?-tj#B=C^n_9KX5Ktplp+&m_!{)`Tuw6m4%prWW3~KpNbqqAq=Q zyPIZXP{*rbyxBfPsT`88xnJY$xL^+f1bjvE^TUDcNSC$glJfj~Jze~OZ67X|jj5l@ zaCrBDv?sgSi4xCTre`vfY)U6FlX&;aq`OT)kG3sl-`<78k}1@_aUUmjLKz9b%Z^*K zm6|k|rB#DG&!byL!4oK@1(!oJ?wd94s=HAv@EV^>F27GGHoTnKS<`uKUdu+k_OnhF zJLzkZ4{-R*M5BRYsw6J<3CN>4)X;eNt1N_X&VLC;BNAZ_M0~F{2Il)0tvhaYH}+ju z*O`3t3QUvo1l2}I1)t`=Dqti~#fk~j7~g# zPdZN-C0=CJoge%)Sd6sm^II2l1a0aXk6_&BVlQPhPf63-xo)0mA6TJ{o7#1Xlz6KN$oS^WoVq^&*xfb~MOd#;fue z9sZGEMnxYJNR$_Czma7hYH_9Z|AjHe?>Jm;ybDFdD}6B0mb`>WZA!r;wKDlX3>mhS z@9AK-sZNJ|Ok%y4YKIT}u)s2&nCE@n2@*c>7k&{p0FbgXxlPw*8yXmx@S;~t9Uk-Q z;M`47ckNA7f9gj?gx#k<6!0)%BlP|G?1+DnM1w0!jTaVh-;SrUEV+Utr@HJYcAiVg z60lL+O)bh&+X(lFN3BYbCuQ3(L0@uL;^;!`c!_Bx(uiOa{5K2!DB8(-TT!GY&-ne5 zP0_4VI-!h>yFz~Q9o`4C_udfQVHn0GX8Q8C$_sr3xzNcU1{VnE$>gxR;t8*gPF@imNG?rSeL%#Je8^L4UHl*viWPag3LTOqpIW$xKGnZW~o)ZZc;*l^PQGI0v zh(n0Yf-mygr7Sc7=W{t-Wa#@Zy!0wQ+PhYX=nyV8B-j9TWJbDwkA^xeiRGi(wY&m0`_zlL@XvOh|GQ zL&Lg0!&~x%m?KNXFYTfCz&(@g#$V~^&FOn?vqG!QfaDAJx0Fp3^KRpfs2h{6#v%J?C`;h1R4W)@|*#P`u?_m6* zKg8$aM=W4Ip&59jM10#>qHC^S^<_ki5JZ;Z`?8e5LPh)@T_Lf6hR%>XXYHHDSlFxj z>Nl;}fK@6Z`QM*qhj^437V*ga`h&QQ7Klnfe>OfyR2^N;vr+mMxA_)EDzL#)O$knV zYVFL;7Ifz?{GJqc(DwGIs@J<7b_8c3J=3v4dqrRU&GW%25sq~ey+&glo!s82hN980$?!LFns>&2iXD&-exuS{^%Ii8N(f*$gb8xpX6N9nCpD)@ymE{`4tWtE& z(;xfL&&c%7Ch)Zt7ZU2f{H0|6tWV)rCmy&PklH2At4R+60^%bJrr+$@5#DWz*_ZC^ z78DV;zz0pL$&>EW-9v>NRqq6!X6cXB%q)bcn5alYb}7d{+&=pIgi}Lna49Pzt!px* z*@8x9f}r!=mUr*kFRR7iYbNc{z>7^XD=^nQm+l{u?s5NvPOH3xurQpzygoZG-_(0B_e1bi1QwdRKI87@ zGq>+owlY6=EKQ9*_c}j72B#C&ah#8>2_uAeL^DsaW=qe)n(e=g>DgyP07_sZ8<|IY zyDqwTB&5&3g*>6{Fg8}?y5H0Z$vbb;l@dIdso5ByWz`_*c&JbSXaNj+oYLOz!B6vU zu*8agRkR{-hQ1_pNX(HAQs%Vzro@@GdHj91Us#H8jJ!h<%ZV+~V=$_yB`u$LQus&`{V8c8&Mmz!nSu(=-nrrcD}I9!7~<# z?q{u`Zeth4^HnDn?M)vAZoHWn^xfzchYxDR;|(_)Un-|5Y1(J-0N5$ZwvJ}Pjoa

CVT0F~ikR)Z(8xGaTT#`{d(M36}JpJ(g82#HFS(LjV+$?e49RV=e878px_- zRA-PHCdY#7r-N?-PPc_KwMxJCKB=Vy`)>zHmL=6iWOx6mzju6qaPB+$N;yn1^j%vf zb6D{1`>B&SsLI-xUTzUGXL8*I{BH(!bT6VAzt<}vhd z={F#q`w^0a#g00szLJ&kcn3iH*$Gi8MKJl1<;X!;-s0_JG|kFwerwpo4@H{24GB0O z9_ZMa&G&U&u$Wrt_{!q3w_RvMVGKn~u}@b`r6}Cd7Hc{%RL0iI^&H5;=}))x49nqa zzPFsb?S)}UW_N%|0tq7q_a2W-ciwb-@H#O`-S&TIS+bS_<3Ciozi-~IWJnregfJy; z5TUoQllzGi+@AVq=IuRg%Eeb-p>o#S*~>M7@oC&fez5h!w_kQ7p4vvK@T%F{zklu` z&P*W8+U9`+;JxM_>&nm`o99-d9)rQ6k6JbNW&Q<82cuWF&i6XGH&=cFTt?XJdYiY)f=QiO`uN6Jtbe?D|Y zlJqmae*Sbk%_FKFg(V(-$P&!F$(2f0SyFaeJJ`u{MCYApFSqGl*r)(XF!;!^v{YKX zR&orf%e|}|AQXD5JK-|-J@A8?CA3YQ*B{55qz&G}%_cZ)pgcHrI5S=ib!sI)rh=9VS59H1zsyS4HS6x=1%nPP)_$^&j6det#&& zGGTNZrD2;ut!^Dk%(@(YX{}0wFBY5t`%wSbKYu99P`1;5xkHJ$LM}Aobw1$voz%gn zhuEYcm?K?rr37-@-;7Q@Xt0;hIawD*3vN;GEP~E0c^~kGaBAJ@9yG!bR&|N&moDa= zZ(L2C&+AY}X4)OOBm7n8vGPB==jE`5Dy6S4*BNwPowV-2+Ko^4y!8%3jR7c6{LSxT zfHOo1*mL{VxIcERyTiesAHF@VCM3D6u7MlZEC$kN3WLh2Q!{9+F8;+^Pvg0t?VaK} z!Jj7`Ar6S@gOx0kfpMd-lW!)}H5t55>r=nrMbN19eA|;;ed>E^*mc-dOPe3`u4Ik- z3j~o9aS*02}?xY!& zo7z-ze))We#wl2j76hQQ)&2CAaOMR0p{MeJ-x>k05cC4Nn@(^CNiZlk5aqQX3=lDl zgZkw-2r>^kAQhXG{lrMdc;UI5l#4t-yjuz4@V~#;;z33E;RmtH?uBEu7)WPy<4`e+v$6pc3MjVdp2|-5s~J!AM$q=g)~gj? zW5PZeD%joH8P=ktq&LueN<*pX2u%o3MQF1ZaUJ7sHs%j05&~O8roek|d7vN?IsqeA zy$R~6JL=3i{?*Amo&!H%Av9GhA^SWG-+dlGdG)oS*@6NQbQ^*ds!U>c)mBx##ZhEG zOwX2lRTk{*OedM0+Rfkvzs66H4ct`uDl63nkkC0O_EL=;^3g5_yZ}@Zf!_W8fg$~1 zmPGmDe<*FZ)aA{&KUGg2T}k6Q!}p}W)h>pbh?(PjakjC&C?0 ze-rjLsY-qdS$YqzmpQ;Ch=5O@)>H#Mz96E2;cY-(QI zi^u2M8buQo6EPAeoS~9X{Y?V_oT=W*dP%`lfoB#4X;HT-nx9?lW(iG^*}No9J6e?5 z?|{>30wcR5qWCgY>VE*6Vv>0AM7Jrrv0m(@y+wWsf42$50t#cv%zrmxdWwveWzJFX;Ga;GW^u=YL!t`)pn7OrBL)YW?L%HCy^uBYeO5 z`!An+5MYnQR1{%@4^ZIN+#6tc$~=sP^&s_y&YqL%v~0V1zmF5GCpA5JFu~1fhxY~k zTgA1ial*g986zIJY)Kk%vviv;WO}MD*ZP!FkUqwelqvLgdeI)$p)y&zYG^p|^~=yl z@3XHJ68k9Bp{%1z5C>ecBjDcK)WBBRyn;|MoG8lsRnv_@EQ@=1fm5nz-7&_>ooA$_ z_3S{18C>j7x)FoV--kil*TsC8a5aVXNL<65jKLQX?U)FzlFg}Y3r$s_zT*~#j0xv3- zAZ-!Pw(aPHeHG_KFRxCQBoD1{R9R2E(?KDxM)gnS$nS_Z9y-{0IxgKtvm(%mYcB z(`9B0KEL_j9)b4SplwL*b&;ZGSHHk7AvNm*wp*qkjPpCuPtT+Wuc;)s@8xEO1jtCa zrL|fTg%LZM=PUOfOfBY;$=+;Ta8s#Q1t@LE-Q#d;e)V}Fi=Ku*A`?H3J}M?D;N0Fi z$#y}0teg+EWUH0^=zi^w%{v>GPvX-}S;^|#DCiQkhOsG~+X`_alSx_Pp4QdV_DKs< z`$$Ts2CQ)6PpIkLIJTv$GG2@PsOiuWoU|)c-k^}n;1g)n;eXBBu2T#_-cfMm5}l_8 zZKaWZ#-6HFnMnD_1 z=NF-6&Yh2=gxkXXOx?Vamt*o=T8spQa&6pj+{nxz6;)S`riIxBi?pL|DuypC?d|`T zVS-f8!(ZN!(ClbUMXW|d@7}SKCG8aYm6P;!UM^ltLi#&3Rpaa+kz1Kp?SgBtt&9Qd!bq=SxS$_5!)lK@ASJgnp{&BL zt6R9k-0Qh`m1HnPcH-nV-+rzQ_oBJ( z$A6~<`kQvm4T|`9N0m(JK-dLM%jShov6%6&)+zOqQSvBh26J5%Gcfr>d17|@Iqx&D z+Q_-#!r>ooOlE*0QcluM^@l_7$af$J(~m?BLrqHD-?wZNNBU^Er1r=DNG=CLYHbQu zhoOXKdCSas;&R?Xj4ZQok)-CpV@}HooW-WVh|C0{Ll2x6gDZ?kuhr;<>AGNMwzr16 zQ+ya^*`g>cGbSth#5hI>+smb(#N{&T#L7)SS?-bPUq!X0FQh7?Q3;&wQzKrt@_D}* zd!~FzpJM~K4)xhP>)pvY957Zd zUHikrO5AbSTPD-EZEr$L!jaXZRy_kIv9&hp=-cz#KY2I2&vo~ThUX^r?^Xhl8F~&@nP?4QNiUZNd$Vp0%63`!s{chP`PW zaB9jc8GORdAnMH78s;MM5Q1t;!GqubTD(&7lho(Ju69*+{a@PZJ^k%^6MYx@aHEYm zzx|>ev7xsJY!(3Y?cn=_Q zd@-(K4ffKIWr{q);+>P9Opyza!L9bDjTxC@Eq&6K2-zS%R|5b)Gm5e8+D=r!iIN(3 za#mq&dNN+L8Z{kHl&wLE<%D&0$85A_!PjX|Q*D)_Ou7(%*Nslv}VJl z8}J&w;^r+Aak=$5b!t7bF1X8+c%bec&}+Qw-#e3N7BN9`Z!RpDX05wX`a9+j#VXcQ z(zdVD3%i#NmL=Kskpp@Nc#?ILK2g!rc(Y>cAlz4_H*y> znEy6G24Ig+)A+e4hfm!gv#vBaKj%?`ap>#83d`wGunjzZ~JvaHmA4 z2E-{wEdmf)sW0l@AM@zxk=fs%PTgXZuNa_3fTjdDAKh1sD|#yeeVC*}7OP8Or%P-| z?4oxZstkcxvaIW%UU7qleZ7A0^qXDJQEOcCqBi5mfO8=hRw{=^s0Pn}60)b8w~$Sh zN{*$%Tnw%U96m}WK6chV_7b))>@fup;1dwy<>Tk&7cdYIl;Go+5EA3&