From 96e86f2c7a9034b783fc1e9f1743d097cdb5c7d6 Mon Sep 17 00:00:00 2001 From: makaveli10 Date: Fri, 22 Sep 2023 12:28:31 +0530 Subject: [PATCH] add sphinx docs --- docs/Makefile | 20 + docs/build/doctrees/environment.pickle | Bin 0 -> 78578 bytes docs/build/doctrees/index.doctree | Bin 0 -> 48761 bytes docs/build/html/.buildinfo | 4 + docs/build/html/_sources/index.rst.txt | 25 + docs/build/html/_static/alabaster.css | 703 +++++++++++++ docs/build/html/_static/basic.css | 925 ++++++++++++++++++ docs/build/html/_static/custom.css | 1 + docs/build/html/_static/doctools.js | 156 +++ .../html/_static/documentation_options.js | 13 + docs/build/html/_static/file.png | Bin 0 -> 286 bytes docs/build/html/_static/language_data.js | 199 ++++ docs/build/html/_static/minus.png | Bin 0 -> 90 bytes docs/build/html/_static/plus.png | Bin 0 -> 90 bytes docs/build/html/_static/pygments.css | 84 ++ docs/build/html/_static/searchtools.js | 574 +++++++++++ docs/build/html/_static/sphinx_highlight.js | 154 +++ docs/build/html/genindex.html | 226 +++++ docs/build/html/index.html | 295 ++++++ docs/build/html/objects.inv | 7 + docs/build/html/py-modindex.html | 123 +++ docs/build/html/search.html | 117 +++ docs/build/html/searchindex.js | 1 + docs/make.bat | 35 + docs/source/conf.py | 36 + docs/source/index.rst | 25 + 26 files changed, 3723 insertions(+) create mode 100644 docs/Makefile create mode 100644 docs/build/doctrees/environment.pickle create mode 100644 docs/build/doctrees/index.doctree create mode 100644 docs/build/html/.buildinfo create mode 100644 docs/build/html/_sources/index.rst.txt create mode 100644 docs/build/html/_static/alabaster.css create mode 100644 docs/build/html/_static/basic.css create mode 100644 docs/build/html/_static/custom.css create mode 100644 docs/build/html/_static/doctools.js create mode 100644 docs/build/html/_static/documentation_options.js create mode 100644 docs/build/html/_static/file.png create mode 100644 docs/build/html/_static/language_data.js create mode 100644 docs/build/html/_static/minus.png create mode 100644 docs/build/html/_static/plus.png create mode 100644 docs/build/html/_static/pygments.css create mode 100644 docs/build/html/_static/searchtools.js create mode 100644 docs/build/html/_static/sphinx_highlight.js create mode 100644 docs/build/html/genindex.html create mode 100644 docs/build/html/index.html create mode 100644 docs/build/html/objects.inv create mode 100644 docs/build/html/py-modindex.html create mode 100644 docs/build/html/search.html create mode 100644 docs/build/html/searchindex.js create mode 100644 docs/make.bat create mode 100644 docs/source/conf.py create mode 100644 docs/source/index.rst diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..d0c3cbf --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,20 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line, and also +# from the environment for the first two. +SPHINXOPTS ?= +SPHINXBUILD ?= sphinx-build +SOURCEDIR = source +BUILDDIR = build + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.PHONY: help Makefile + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/docs/build/doctrees/environment.pickle b/docs/build/doctrees/environment.pickle new file mode 100644 index 0000000000000000000000000000000000000000..b0c06917e3ee28c8299b0c173e54ef7a10172d79 GIT binary patch literal 78578 zcmeHw3zTHXS)TSWuikm?OIk~gTMxXwtDPQcSF){@cF|f7OYCYSuhy1?Ew}D;-l)_1p6d5?~{Ou zA>aT1RrlVyw|l1V^vp_z-6QpM*W<6MzyA8`e^u4@yJg#zYO5RURWLg3YOPpm zT5YFRUFrtorN`T?$MCEBA}VfM=mt9-uWlowZk@L-*tKdmn7HV*&ihTPjO59SPStPP zt@&E@0)Fm96Mi=sS)#t6l4{ZKw!3G$!KmLVQ{&D=!O1zhoJnWOnRaH7?sZy#CWXpg zW4XH04W?8N_3zR9BqJQwgm=MiwW<}{$0&ml-)?t!nD(W%-SDek!|y(gLG01ky3{UK zIxVY>oNk0eN(EkQA2|kk4#(uT-?b$FIzd87*JW%sESjzT?`nBo`?=z~bl!9C z0)0NG0Owb1%<`pn$*R@7i>2kxJKwolYPYP04;o<#z8s9HGBniShFE3^cv)%LnA~#B z@_pd&vUDd`XYwc!`357^M#a9Q+8d|NaJu72*(q6jCBL)0T)jjKX=kxTYhf0U+pSKy zjoGbGAG^NPm{B$C1|}8L2#V~qm*?Lw?^jo(8E3({P0G$z8)<6Ze)zCP++@XGwmP+T zspWxU)D&E2RVqM5gUJn4-2#7eY#QGS3Mv(-dzB8Rgs>cD>~4GIlD9;QwS-EoYLxYw zbXLiCfOCOQlw9%ZR#i{=t5LfS`uExmuWgrF_OgwBl9j>t_MzsZ>5Ue#6Ea>8@K1&&9{&pITWV zK|n+Ef%*2c9T0CgAG>2|B};Mh9nanm_Q;d6H=eKdA=+CD!Gz{s%>K5!7WS5L-sHh> zflbI5m?Q8GW)yZuVM=JYge}jp{Hl*lt%i;}Uadma)Eb)NJqkOT%^cG?=$zq6=VZ;$ z-*oRd%RbixJ1L!cVUA14uIPN;`8?Iy9i^3GD~R({`Dz<$60LCBE-tTjYHT>1C_U0c z?mACNvTUYky;k)d?7q6V+GImn0J{-`nPJ$FPa5s&a+S90u}bJ`TJ2#`ANw>g{Qh|R;43BY0<2*@?R$BgSWA*#x>&8yYP&{i z$!M6nV$BnGt~O|uDa=VWsJlNoZHWrk#V_R(&T5TQzCWx!pOcxG&2}Omte{l8oK4j2Pt!CzU*=yx@8zGP4kw z&x3PzXtxl#RA4Ew4!vlX+5^`TDbd(-Cb(g6YY%*ZyE4fs%hrV|kf9QtH#m23u5;YE zTfQ7~?vU~`Tpm2RWtrpMC!ir|lse4{BwFm*EJkrNB2xOG&m{{>9h(>@OC@aIz_!=0 zY5++jp|kfeOxZ1HW~*gpUR+f=0#&1Kfe_9UQ{(i#TqjB|@xX%Zzw)nDn8uOLy876h5LnTw9y#^!nR`#&fB)GB9)J8~S6bc|RTcdZTDw(;9p%ia#W%g> z)SFQ6%$a*@)uPv0(RC(C(Z7V%vO+soFy5>{JVpu#jfOrW*?I$DIm&T@+4%lYq~a;N zL(HHs3c0I;ZK@5GilOENs^a;aG%HE40)a@Grvf3IbG_scN0M)KC}UutwNAYOoX5LK zWiEjyL*AD315%^yHET8uLtry3QIbZuC?)nvi4;GNgN<$R+Z&$h)*h+Id9*`7SSGoF z>rG1@^m^8@h(U4seo2q*EukdC`E!!bwh5(}5xI{qdER*>Ld1YMr{=X<-bEj@&vkaG zIxL{MAEkBA>8gJs1;kb!XDV!)A_C{Au4BSkVGp}LODqXeVEKHcyhuaWM>$$Pi<3*L z5StOe>7cS#TbK{tT2ews7H1QT2$N6}i5O zQeivArY`G)j7a$AVJB8a_V`#cHCr}pEit)A!(C<$JfPZG_Q-C-qN3&$X8)kl-0J=n zY6Y)(v|$s9?0ifV&U?%G(2zOxNYyXfFjY1%XMV&ycI&2k@QPWTmtJ~0r}s(^`yU}E z7}u5+MTYw{hz5pfx2+4;LSsxwIMhU2W4P>)$Qg_sJ~999n{ItZ z@%||;(y%WQVvxPF(}1l*_Juv1M^>d!LLtzseNoRCw9@4b$wl zRIQX?!DVd&&4F0B>~1pCLRRRNH(M@=oPFM2#hR(`GzVi4cVTCs0r59)8GQ%Ssv&{) z(i&|L6Qo;J8zkNZ<7EDTSpw?#l(Gzyb+ASD>$cOv;x4iI5=@S}^qMm0a{!CRwdH10 zB;~Zdhyl%Ufu6(OOIdvfek0`$)Q4Fr39+oRf-!jKp?vB!6lE}#k)K276iv)YW=cb2U3d01q92OxQW59l1WlI#h8>Vgob7Tq^( zzvdbeLiR@475f62$JoX{VmIc&7{X%LMa5Ke+A*5Dott!Sr)-S$Z!On5=~ZY7Q$j; zaeX?1wLgNz!-uvd>c-4M$8RkxRT~RVmE3+&l^DiCxKd{>tfMocTKT9U5G?t6h=0Ln zMYIYA1zHW!F$>}nVvX#4Wc=ntrqemv|I8x6OdMs{{nTc`sv;Ndp)E(5wD)U8Q)?~H zLM)>t6ZJwV-ztOM3GCWbH6~RCi*xX%G+?&4pjFm*UP=Soj}DVtQDg$YQ-(1^oER+Y zOzLb#v=+y%*Qs1n|6nx~D&PA>P}!@~S8Co8kS(6iP~}bJmf-g` zp}`yw>(xs(Oq^yh-J_UD%>}O4aL_FAW*F)sSZbe+x&NG# za?!w24mG5uC6HI?>}msMXUMN17D6HAfG$F=9=mk`u1ayN>HVV9Sqi2^Q)llmc>C#X z!5$+;qz}+ZFbai^P_!8HeNQVldMHDVJ*M2^p+i3O?_cZGoW^^xxxnO1P9!ml>9y!I zI50pwcOQTbrd*UC3}%^AfqBpn*&6_V2Y#tSvRi(;Ldl~7r+fOIPOw*P*|dBx z@nVDRUJiB}=`h~Gdj_|&>JqfnU>tZM^Ei=qA($p&Bl%YO3xn;DD1s?A??WuJ#3{U! z*e~om#3UeBlP45j6X5r9u&<0#=iwHDm|ud_P3}o7n-_w~COnwLn|VhMV8ayq7?S;> zpn&Wvh)S8Jk}*ACF_>&Emt%EbtLwrvZNbu0h6-A&+U;cq0Qy;={e~b>Jp(xYQZrNMw36rBwPms!o=4G~W5L7CMiS`2!G7Mfsxbey$le9> z5N(|m41Z7D|E5C>5VFA`5zdZaJ)d+irR}DeU-&Vcr-DfaS<-&MPB0GU#S8>f$!q2x zkA2@Qzq0?UBcpx*Z#-FuVBIChd9VxikQzqGaR|XK#Zh2DY9lyE+0}=Ed%N z5#z%kX-(fyEH2=`_y)dEu2sQSFp-F3=#kBgtHs&xkZk#cghs+-#eyZYaltoXB5G+t zDC1c1t_2^W@;tWh^W;`oxM(l=*bHC+T<}*L<%Ot$5BkBl3QeeV-LHXbxL?NyjUbqU z6_=DGt9H>^^}8QH3`dC^&169)GJs}5{#VDQm2sU|cqt>DsrXtjqZTtry+P6)kcaZD z$^&gGNNb{HT@*e^9C*C!Ac6{tA~Z*=I4a(**8HNXPnsW@zryP7o*hv9e=Ck|)3cP9 zn27Z@>NcvAd2RyDd)v zPQ~0)UMF9+8hNW?HQV_%qQ4kqUR2SxU0cn!z5FTyx?q7g51w%(4}V*}+RkIg>(nZF ztDUEioHjy&;Pk3C0K?8xSW5mG$Q^{;XYyhqK}1=x>+Z$CAl>e#@$EbZ0h5UD@8Ce+ z+ofQ=U{vB!y6yoC*k7`OT+E6<+;>Nn4FgdARnQL@#E9&r_%;rQZ1jWlR<@lYX98A= z<0@)zT#E^azZz>>FfSlf$-NdWx;N9u93gvx2wI4g6P$g)-3t^92+xFs0xpDsfO<`G z7~lfxVa0Jw-$Jx`2ec#D;DDVao=xYZrhO(}=Zu=_g3R>@bJhfb7oMRAqNZqwjB?ey@`PkOYSs^WAbFl z^eZ%YC#7d3Uj<`eEF3xos+m+=Qrprg4)l_W1=tQ61QQ^8!D6tJbP;TJqfWJg9R%N| zRMjwHTr6nV>P}x11FSekc zLNl@4H74a-0BgNT!E`gW9j7=;D| z&60ia2wVsV6|qk&dJV`8>>dOgM}%zc#DiANN1B#7RS^;LN^sh8!XeFxRljDqUseNA zmE!I-J9hMK_uNbd_v874OhyM!9?9RMha$0;$Ma#4{K1na!FxqSD7eh)m94^H<3B;G zJjQUNHNjjo#FYx}G`qAduUn7?@Y?|Xv;Bbg*&~8&7uV)VKSKa{qo96wmh21*)V+-= z-%j;}W`8^c_M`MIhJ>KHrF3j8X+_hTexYc9I7u8P!NWxN-X3cr5(9aPdlxY#<<}E~ z4QIU1q!fZ(um;UTF5)f)Q`AGIK>ls_+(S~x{!CwFyT3+Ryv1+RSeRfe^gzL`*y=QC z&&V+b{JWV4JWd0a(T-D3vJCX|nFhL>2MWO!vkm(&1qLN1{pl^`K^lh!YYe-S=*mRc z6nj}%M#g^@0{bHd=KeYU z#3YAcF11f+Tov5EN|fD6Wp%c2P)RZnvS+8soYq^f?g%QZDcMCBnL$y#=H{3bX%-QI zhmZhRSxxq{?S$D^{5CpzbHeA6fmv)l8XJSi|3|v*ScI;%| zjtxpu(%-EmsoiNYSEC|LS(EX?x|q@z&B=Xs%~XNuwc6V$qpIZ4G7NB1$%p_48Sgm4UQ=ZeyhN zt6960fwWYYlB6{l1N&^&jtx&((%-EmteJ!o-k-E`QAu4$cvn2bAg`}vMOg;&`true z>uXuNl!3fdmo`RT<0BcR+TqDd`n##*wJ~790p1w-@C1eaiSCD=Q2w-}_!Sa$S@umD zCro`g)r0q=qNQx^aEU;k$Du9KXXWs3x3|6?jEXI_8|>*}WazqGSii~lw%n=JSQ~b~ zfOhDBKD>Jv0wN;Zd74s6{!X}5I3p^lJtD<54#xSXAww*03+l*FOhb1L^BWXKKDrA6mt|kkS{E)A{>i` zQ-(vVLx%$3$7I}4elfR9)a|cTPD&JUI73d4=spmZ!!&N34yEYhi^Uu%&+)SSn}Usw z9)f|t&_p2X>7Ii_1IgvNPZI=E>}e1`)=O z>8&?Q-tsa{aA6t28k!(f8f^PA{IImIkx*(h^94A1nyW>4>{~5s6-_U8>W{7F`4}D%9b8fffRqID`Fh=70ek)phb>hct!M~LHO zS}=N)TpR>T%chvaLdD5KIig2t@VLX_9%5zZ+9}D9=aT)FsNHbg-YtDLX2nc4u zxh4dl;b4Xum>vR166X+!VyJ*_#AotEHTp}4)_g!Y6Y~Y4Df&@7hc8cvi;)%=(V{Ly z2*&@2C!$C+wxiIo^e)m$)8W zvmvSJk>s?Tr#2NF*+)Q=X=~aQ+Z1$h5etnRLoU2OtE{tzSN4s71xMQzcTij}8}&&v zkL{T~i@9hUHIbCqZYM~@SphvbX0a##2Y_AOS9xoTt*5K|YP2f=Em!wdk`_rA3fW)( z?fB}xs`u!t`|2xZUp2PLC%<%+>3<_CQ(t`kB`stw*~KqD|B+DUBw6vQLUmQ4x~foJ zRj5o8kr^KFtzi6-jc>Ss;U@tLcEqy;k|T$M(LTLC?9(0eEgqlNzGCrdMG~aMtkh*xQ^@aThs(N`VgC*8jG8JO$`^Xr zq2qybu$tnWc?D6khu0|?A40DH+9YMZ-2EB^+;vP;b~1KA0efu*3Z#_}nj{P4~!CkO7|cHf>}(7yHFr^1&<_s* z%)J?v)6S?QIk-PW$k4%?DX#fGr9@JP%@9Vm^Q;F+(11TKpn%=6|5M_(FOpS!>7&Lhd3BCEmQ)W(Z$Ek|;j|fxM z)>N;t;<1TW{7N|NWz}&!Y#Dd!CPI8S2Ew4=-!ulW8C&to%NAr>{*y5(OiL2^e{_z{ z&R3B+Br=WV@zt$d9%Fr$#~aXSuT9fEVP*smo@%Z5$0d@Wrw^Ts<1re{Gueaf zT5<1sNIwPlzC;5f+(0Nlvh1hQ3^Z*Yjqm%zaS`$3#kj~WLDS!$Z`iudnOzJukJO%a zua;5Mp#|B{B2LWV!5J9avxyi}I)B7>Ck11(Xd|1*oYMIP=_%=TV4XkelbXf9=2`5c zj`cigqWTo+{H8PmV@KEsH1G{{^(eX|2s6c3K>i`h>MO$w7H~x_T~0A7(o>%(GUq$o zdoUZp7-G#R5~u5)pr3q(D*n6S&C4Y)xJ#u0v6o)qxExIDO4pR+o^h`!>R2af;^7ceq zFB|%M8cnuC$<+wUa1lcC1Z@;DnJ@~3RH7{c zeTdIA2gF7u9ONlusxz4bzWFh`Md45greZ4QQ|5kt$wne+2K@2@3)|ZHCSh$ptc^H& z9?CSbc@GWESS>FY!-}!U4Qy*_?|za%3Q-8^-fOhcLuLQdxXO-WiG(cZ#ZaRWG7C-D zz#Fs`ep89G3A&cDsnv87d8B4p6`a_&T67CfjubKuAJnmgDh?O1gvjYtR|nB@Ekrhz zZHkMAwqzkZjC^~zO_jt%uE6SC5T5>xv3aQp@ley>3wn@ogC zaZeKAP{NhT3?N*^*hOEtZBXIrpA$At(Z?s~IhV{i>C#nTvROF z>RGdmXBcbkGa!)2tiAqP8%8|(bfT>*X+Mr5MoTCux6-CdNXZeqpCc6L_ES9PlgQl) z3CZxB#4*91lP{swgpd>`7cD3CCr49MiVacr`(HMuJ(H+(YSF`6VYosMd$Kyp0*hfZ z0t)D+?H6yQk+nR^(8p^MJL@LEGgi-^7(-is^{izDP~y_32xMGb`l``J4{_@8j2uV(DiXp6TjEXEg<}!m25?hEv3nBZ)K$R?n?5A%mgz&db6hcDE-#Q`W zb-1^$rj7(&ngoGJdhX?#t&qOH+fB5(Tz1&kn=C0cAu6DcEw7Yf`O4^EPw@? z=+NQ4{sI_AGPpI-R?xX}b}IuldTUOJ2BU)G5P8XXlVpA}+9a9JQkhOP@cv)|7a^te zQ^7MFD1RehXEU3x5ovOA2w;68O_Frro*-oCNlCHC*CKZ-PHPv8}E=O8%1&Owi(p@u0HKpK#Pe-*R~L85)pW*i)=W5>9=)|1P@(8V zF7nEF3QtzK65A0|BCX4Wuw~So0X~&2bHHqc#>`Po@i8lRoWz2x!5ic)E(#zaHAQaB zh2fSSF)~dU=(`Puvl)EUeU3n~*s-$@Q|lMVQbH1@_F>Zpa-D zv|Gf3^kU*(v_XfwJRNy8uHl-~7$qB%@++G-DJjyOmeu`9LBPPId&e*c5x4EeKp2?$ z>?UF+MXob~ncrm03`MSj+|3|YHCsfkaphde)rX7 zvqfC}KZ3>fxUbVUw#V_e&9ldac84vBj=D>(TB0}0NH)!6jw`Nbjx%9znMLk~xQ1`G zxt5y_Z^zLsQ+ntoA53N%YkvQDoc7n3b%rs@?M}26T)J{bxg>)0vPs$HHr-{H9JPB3 zp+UEw;x$vq-3k-btNK%xvO?X7mJ?Q}B&^86%82c z?W8gI_1D_~Hky}x70I;TZHz2!rU`x^?p8GBMjdFvwDP$%Ir4ObEG`nM6`l0Zv&aE# z5-G(F%Gf;;PhgP7bi1d^GPaw)Ditxx92`X=Xo z#1o9S!onLDVG^R_XWFF1CxI?nWProW#!eeW=XUsQNU>d=$AOFp6igTNG$I}1$-&x3 z&-L+PB3jE&$W4s-Q;(ljS1*#CSg&{q!DHG=FooE`A@=$+Ga&{c_9nlG6WKybIkNSE z)c8V9wx-ErOkg}AbqYONd2|LBFs{;=LQ(`Gv@uSMV`!SrJu#D_`|BQ~>-*@oL&cc# zxkAI!_VneJSJ#6)#Ag8UnkwETrw0ZpjF7Jfq+W%#I?;t0%P@-Jn#oEBw~G?;aNQwa z{HOay-gX>21gz?Eo{V)EC{LU22+dUd;Gl*?lN1Iys!IjUmGtCfk~a83xU1Ch_m(;g z_Vu={WM89wcBOuHwv?Iesk0W|iH5P_0i2!X{pPqj-zW=& zkudc-?!u*Od1Ge~)0T`e)ut)Hhp7hknwy9{Wygq^zcRtq&_)&$+?%%yS0bKm0el0e z@7YA0Dho)2(u5{btJeUR3hRoESY(M`H0U9dDeb+=l*YHlkZP-JCah{I zYdCa8yztEN-?f?;&2%x+uc2>JL`#k?m%&^0q$hG(?7nw|qxhY=nA{NZjZiSCmeI|_ zrn(rsLi%JZxf?KY3Yxa;w39*Vi@H-&x$l1d>G}6=s%V@%_wS=`gdl zgqi7eT_EH8q5N^2%wi)votuvvxDkD+BQeP+tt5z?W)|UV3_5`-6F1ROYh|a?IKK&z zY4>g-R+U*S!m0`wxd&}zF^ko&C=x?mgEfgO+_pjCZ{EbYQ0BB~E|fWKk>{eHJ~&YP zn@nd)gBaMH7WGNd$6Z1n$@sUA>o_%>hAkryyp^X%faO_^-kYO{SL7}e;feNWoO*!x zAm2!k(EIoj7$3#G6mxm~PqoL*kaq{`jf5-w57!djpRPvRHtoD>Zw`g>w0$}Xsnhqq zh_B(LO~kisv>8 zA_|ojcC(4YqOBq_FZ6Y1tR?$J12m;QcuK;ZX;>eOX=noEm?^4nrw6@|=CgzY_QCvD z`o=yO{!_bRyn-U=~=2Jwe+83*WXQW`dNP4@b(_=>7f|AO3!biZ6z!;BT9O zir1q*p_&mKurJ{*=ys`P<92WxhJi|HX|=?U?LOBHuI-syt#qI3x->5L1NiVE1aHkN z4oA<$4+OA{6z>Bu^2mPCBU%?vIP|>fum_-?J}g2`v=BoyVT2j39qiFqJZ$&lXd`x6 zZE*B$_uNb(+wuHC9@@c^NAmaJ=C5)IPc4`HCawfKo)3%U51u^vwBDEtvZp9|GIof+ zCCcgL!*c&cqWx`o4Njopw*hG^*9TI+t>G8ZfVCE{`WeD9zmP(`?6GFn5V|7|feJAF z@etTwCx*P$_aye1XL;9z?@9a*2{iBRL9U^YEtv0J#F&g5GEPRp{cnVy&*7ubO9{z~ z7(de&pYHY4xc0TAuFu@l6CZm44)n?zLeCP$@D67l-o~FJNs@~>ywn!)e?VQE=1RgP z%=Gw#dxXZz*Cm~#Z}js!KdM50z!KOksh~vJD#IY6&5~25HPlPr;awqhy8kW~j#^YUg(q;J}Zu$cFWL$(nLf$clRh!;ghIvDiUGy&VdUfL= zc>2X=c%2j=c|W{Fwv@hozyc|s*LQ_QRu}-mRTCuzNI!c0h`N1(pZA~+r@PLz!q=l! z+ql;P!|zj@@XcMM*kF0ip_p64QffRQZP;my9Akk!Wl&>G`sugRuVGkIrkXbsNZvA3 zkl9<106On$s!3?wPyPj7x)|zV=c}~c{zjy2LnggS1${Y_aL2!^9M054+)d<9%IX#I zC*>e54VTL_)f#QnY zF43_cW=C870_43$YyF~Odvr5;4D!xi8e5MViGlTc7czlH$zSLWG+{sg?GeYc1#B2&R(wc_3T84mQtgO!%Lm5umR_g34gQ=h1CUfx^SkAw_LP;fXq8pPt3 zrJ_Ncf4qrUP@-0Z1tn^Ig|RS{s3nL@F~@;Lt*B3GW`294eTqaalkDLi3L6>L|7J2j zK#sA;zE<=>{cqRp0+F)+?Erma{~LeX45t&xKe45>MgF1_xI*AUi7k{H68Me|D)2?^ z^zS~Z2 zG$mZ`62AK!YfP6!Qfp3RnzxfW8gLv4CZ%^PCcS-xgH7?+Lb5TC| z&{cXeW|!`m*%FHS;`1*NO?~nCk8CYf@g+H1L01fTZOSqj^?M9fwi%4teV#zZ72*`T zd;_8*Vggq9Xm$F8ih9yJl+p5q&>5oq*WvH@GS%l)Wvy+-ZOGrdiFi_mg9uOR;?(a! z8(9no-#jE*LV=e>)uEvoboKE~#FsKLr114I#@7ZUipZNIC{M|p1DhC9efogRVe(wa zx2%8DklkuwU&Prd*|A{9jBd))J3g|)ogr-s3oj8eA_BrxV}5>h6Xz#I&nlk#mjxGt zMgs(I?0>aTR^*5*yBPottbJ}1v6iB06`B88#@bL+Er{O?s#Y^eR2|n!HUK&@p_$tO z3|-+O8rFnnDo=oXFZH{xW+|(DP!rnU5-c{MT{DSqY(nF2-#8|;*R?v04cX3mK4sQZ z)$KI4%xG5V(_q2D+akD1)N8d*+;!Vsx2<6_+W`cayB?<)Yy1GsZm5B;FA)u6CEJ&1 zYpWmQ>4U*oVDncKwy&84ay9nS7X$62k~%weDUg}V0*53SxW6rdkIgiT9Rci3Gm8}% zSn4vMiI502A_{3tP#K*q`_xWOGBEMb7GmOl>HJMQ4Jka>cEaoxej8nSYt}9m(ZHHV z1#UzEv8bpn9Zhs;C#`3*SCV9Otdg~3C;N6R*yDGaG#e!!ufDgR?RfA$cJ*u6yAZAz z?{AiEFm<%y&#=-2m=M#(fc3GlCK-!+kZ{y@C!9s@R@hjt?aOdDEdIS{wvTa@`LedE z9_RxmWloKaQc%0wAdO7s)K{PFByUk63y{Rmhf=sK;C0Fx)cV~Z8@5CkGuXC=TitQ`9R@Tt136lzIx71d z()qWtA;MaeEU(!}T5lTR4(NQDQI%%Q+{cU|4mWd3XL^Z1^0HKJ^N%7Siw)qJD}^>e z%hoq%VEkWgBF2@zmBRSXGRB9}w`9_?FmN*_G}Wh%Y_w02mSwI-=t5y5!)jS3PX*){ z*Bv@g;R`h5tY!TkePb<)ziok*wSftX4hoycvw(%z0j~A1u-*~juY^eWYKR2>wi!q; zjtGO*Z2IZmcS5iUuE+5q95TAwJjW~c*lzGD$(=VsGE`=-2;2TAcfZ@zS3*;=dkZq2 z>lWPC;xCRUu3^y&Myfvg(|y7HFv_}L2g=p*{4V@PH1*RP2whN?=jQ71idV)9CS=ru zW2@JIl~^X*s5#O!A>jnHUBjcH_I%sZ=$ogDedqmowA88N&>vqx-qrG)k{<#Dm2gG! zlf}CM2bWRtM$|kaNGtLmL56cuIygr-imAu$9hAUZ*chnkb@$jR%w~_N8aSu_t`V?h)#bI%qphjZf0WiJ+&_ zB|tEt8iff-Hy1->59_q9SG#mpU60F?xi0(f|%01K!neflQ))^k;2w|5UA zH%6nH_Q3Skp}i#nt7z}23B)z>OugO66H?P{nWW|>y1g!`x%Z;R1_^BiRX2^$+SHGM z3C%rA#m7S=^rNurWHu|Ad)kk}6u@UT3UH$oHYME6w=Env?$6u0=vP1bGV&7i70+Y( z8kLqz>UxQw#}>twQrCwwqj(KA_TvDSmAW(v`q9<_p{?)D+|Pcrr2u}{ zW~0*7KKBoC1H^M(_sjB!+H?OFAGney8%`w5sLMN9u(wUuLExYaj9DcFlC6+^1y}wQ zf|0h@wrbte*97v^8Xcyo;Acl6a)yMDX?2-rNda99CUr^;QDoi40Qda2DeB7a26H4> zBFM@wA_}q5hS<^#M&D}HIuP}=)D(=$J67FAmt?TTU;zQ#Xi-%N6DDz~G?|WT_5~Yw z+#ci{s}}wo3FhoeI3Fp|YP!%!FjBFXIxB!TO+pFDb%2Wp50Nr~xhmTiiqG^E} zwj9>J!OTch4rZz6AT=M?TQ_SMNjI3%4}$^E6}#&^73@K1B<}YvRpizBM!Cw!9Yt`| za+T0BQLTVZ?d9qvcou_ctAod1qa^nWBmz!VI`t-AM^S_aTyg^LT(DaWt46am!zoPs zG~-cH)3-YnuXL$SR5S}Y(ev$6ye1O{Zqd3>^{YaaGbM!fk;Z~is9uig1tF_!663+S zvxcZ*pcPfJv|J@U=jm>+pT40TSTlJk+6@8-EfnIabrDk~KS7vtw6H)gjTMkzty+f= z`^fCUV7h5Hqno{GJWvdppmKDdmW2BUgqeMm#!Vp&kLKbkcC08!yGWn^rrYkoikxmO zmlJ>}B?9y%ma@V3umUP=r+a$b`A3(7S$`F(=B1KTU2$soA9S{}=7BJSN%ozTl=I{T z_*5caN~z}IMt7jV{S$)v>at^j#xYH@Ab=1aEh?PvG$E`{gN3xKZJSfHeSH>%# zm@&O_@qS6U4X&6dhf{wmz?*0Ba&iAVwKr=c#I%AHwu(MDHst=x!M-xeoG;nXAZjIL za7G7T2<8Ybu}R;qEeqGV>^ua4IvAIgZWD`|rOg3EjFZo-N$~8>p*xuWHn<<^SL|hC zvB7R5mF{8VWI$UEe~@ldtuROCTi9T`pnKRXwoBj#?EqFM7^4ch+zeK!J4qkEMIZke zADv)=N{|{Pu&B&s&WAUPj3Q(l;W}(`;0xdQ^1JsV&;3#QcpqJ26wt?8NAdA?`uHS$ ze40L9OOHt3N+0x|t;=uV(u*7}zv4j`D!F_K6P;ys`TQ$I^1B@UPyQyCeN?=w@eWMA z=DoNROocof$Y2yrL3NWYD@-9qpvwu)<0(YYoC-3nFL||+QFL!2F)Te{6r0ekGNj!G ze7+}!_Kkf>SSknGDA-ilLzpq>#QjSmzp?w&&lf=s@9mz&;%izhELc#24{DWmLM9bY zE{Nq}+F$jtigix7jkAZ z-9)j`^ui}Fs%{Z1Dmhyu%6CjdCRy5m0iE<=0r56~$f%l)s9knjuv2vXoewWQ_$Y09 zUZ;hv#{B^x1RRNk5}fgNj}k>c#qGG?ia#-ZIKs}RpiNAF>!NLSc(h#@9&N4<7!lGY zun2o2%?@^jbjf^gmwIvn9Cn2^v|NQYa<$<_Y8Ut*6koe-QRsiy{Th~m``5G&0%o$oiZ!{?N2RDjxl1ynJIojY7U1gvk zLYR5O?%x75_9C!C(i9U8tl+Y3Zw}%o?u2ZYz!t2Pmeq9nt#Gj}hHJ84v7zwwZ!_a7 z7}t^$_D|Z%5YDR1bUCY0c07n+_tU*cOf7N9`lSHQE>PB_?B(T2PCf`e{vM%@Txn{kWbfC2)L>!c=K@NJCV1cDO?Gq&N>ETJ@mowvMP?A_!mn6)wrK#eR+50vi zRs2F`$S*rptn;RAT%7#V;mP8UG9zeEvbb$svPeFotxz8+4*xrQ=LV#UFK33_hc2?X z3l#|RnudOW|M3U_mXs~N5Iz4YLj1%SI*`Wp7g8;ELI!?QeOy{qK-=H(kDSG&c>>V4B9)2t{hH_=ASrr`d;^&<8CNoLv~lyLXl+#{MUMW0{YC>2HSp#QZ| z5J}{3VE%{%$YD4`QE3!rM$u>#*`yqtr>Fd2n)2X15XS*!NfN@IVo9?og?KOu6)M*{ zh$_+`p6>d=EJgPCq>r}{L{_cQ+kLp8yXGw+jjQ?H4z86g1C%S&IML zRz~dt!jBLzSCXKHuKOR!RXh4P$52F$BJxWi-pH>m!N0z8Y6%zCQT&nm{YJayUBvH^ zY6Zi_mtAlT*Wl2kU>N)ygNv5kfGQw2n5p__?Rc5X!9=O-U_5xWkbKKiC9B~z?u$|o zgEQtWxfJ(9`1p175`l`r1j30L2%|t;4-I8Z{frkG*D)PbLRCaP6<)%#kP0^G1Ut&j zCRcdv9Q2~!AgA9!d<#8ij1c!$BrUo}=##?MF!)DXk5c5~v<|#_3|QdUvq_yoXHOCP zSmde;{7Hvt7Tw$M{jz&IJ`weEjQ?QNBZN3(%p;gW`%-)~V+mq=8UuZfT#NyIyg*SG zPf!HUFVV+Air|^1xSfATAODx)cD|oNb`Ddt&Kw2m{0%;AzY}bCso{cqCprT<8mtae=~Nq+ibAq}vAK$i z02?^k@hB6)103u5BKpSuSPo`7f^lAMci+|U|^d6_wJ-klc zxVtG1hGVBr0Ko#L=ew1$E)=z^A`XM2u09dMShp)N8+RNGhivV~G)q@{-sKYSO58RY zhr+ z_%=wqR~+?5H*5>Uja)t*2gjjvblZ@C>p6!#23h3$ZerBUfp>JCR^XV6O&!3Dx69#q z;Y#YbZ{ek1a7*~>K7)^7*CQM`)?)=aXPh(KjQgEb`u+G&YmA_Vxt)*|>}cUMUBqCb zbUIgt^k5got9wn_Mwpc-Ml_0BJ8cB{QjzEsm-_=~5D~*uigiffDK^6rBT6FRA8UD+ zR%Ks95ESzmFgA%muOW#1Vdkyx>n^d>kM4VS9vXJ16O3|DF2eJ7sac`p0o`EsLC7(*v%RHJefEBd3j;ns(8V@isj-mL zbw7nZ1ylEX7aJ7QOEuIff?&7Ts;(f|x>k~yUkWCSeRivJ%s8zguD literal 0 HcmV?d00001 diff --git a/docs/build/doctrees/index.doctree b/docs/build/doctrees/index.doctree new file mode 100644 index 0000000000000000000000000000000000000000..7151b12e7159ddd82ae1cff24663f5ca89d8e8af GIT binary patch literal 48761 zcmeHwdypK*c^_W)TD*9G2oj=b4#5ZZK->ZZMM^vpBu@}&(U2e-fJw*+w4B?WyP3i6 z&T?lKz|m2OR+$V@)k$P?Em?{rJ5@Z(QT30J> zz21uIUfdJY^{Ccudab1QR&Va-d!Oi)#Z1S&5=Y%m&FhIRc%$YAje5sx^)BM!9(q3s z8gWH6Fjb41nfm^O_{J4Kh}&ML+6XRtj_$!tf~e&*-8k_&&T`Q3jykoD=O$j=Sz0a0 zka@WTs_JihSAap%PG6OU9%AB(z9&22eu-EAjM zg8sNk2cu~>yu@p)I!WZL0t}}STnbt%N1df^;sl8k`%$-1cihBjco<8m7PS&LXrT?y z=|oZDyqrX}q~m!nJN2OB)e^u^>G@L^d;W~rao)R1sQOU^@%0|jUre@L5IgDlyW%BR zl-wlg1V9~_g_vV|P>;a~Vyf0~;~0hbKGAZU^4oO1+crOz+}fp%x6JR%Tx~WM;&-m-Md=p#7R%=Xap^~EJ3DM0{VmgVFq>vz%S-8 zB=#!!=C5?zHWr?qn@8HyS)>8UK#PJExk9z1eS-O-t%KZ!Y}xT#l_L)xjo=x z64jOV>Hq#6fUosw=Rvm}HTZpv4@ zr8ufx@{*%Y;>MRw9!@%LE3RS9^bQ|&>fYs`=AAqfwIJ=9-3BBlhSzl)C!cd0G0GY) z{an$n)RL*4qnh1HWtbiE z(4gy|4M$g5>;wbOLtJu?VmA$d3C6!Ydy&&f`kFzK|5f659{LOqJwNW979(p?X3ESc z|4q>-r)iXOh||>3@X>u^;OO@8=%9B1uTTyf0fe@N-itSMj-^vf&iHf`_6TOu5lA#` zk))vIp_)f({@qz&l^BG6e>g(L)>i*4`Jcetf6EKLK@9Lcy!c;1^gq@TM9lUrObX^d zNnhDPuV@yKKhmLwrL9}G3?Hrk|N4Y2#u`qd60_bc6PGX*K{C5Z)Uh$U^`!0<-%OY9 zF6>fljrtH2-bq!`ej%2E7OQ<0Bki&mXWehM&>{nG&TY#~rXNV$kg-KFp# z{-g{ugl^{w+YcYW<2<)$!l_=4*uCr^!KtBioUYsq;?@+b^V!>Lo*+!fEt-#eJ=VHgX8-q0Qc${@X{L zl6gVX$1XAy`lCXqhEV7aMyJr97PenVA=S(16xy<_NdAWFppYEG$P_AmQ5@uj4bHxn zS54I?{Dc-qGSC0Rex=W9@l!52IpA4>iqI1!QYE9M5I&k-M!yx4(vt3p{R6aZIH9B= z<4=m|0P;ZszKs4t=2Ale`3p)#njEVP&&JK{#mCSw34|6 z=RCZUZnqvpPVB<7NwzI?C=WJ$)PkE7?>Mms2WaFx{Mhm1$1A0C&z^np*|XKN&n|xO zV@?_7FdA8eTU5U7z)=^&+=Mfr9@Jn-qP@h2FOWN zv!~9F*^->4+SOVQV)WkvNh{W5HBEL~!7E)134Wp^SPsZL9Cdg^vYkq)?k28NURs43 zMc~xnvhFt6b1ZQ~ν6vLE82_v9Oul3wHW7zoR08F#LXcy?!1N~9gz@AB_twG9K_ ztE^OxI){waUpZ7VKRQnNCFu+Q2>k60MNn1bfTO(z0}F4tSM%qSXr2stbQl1V1Qf4E z%gaRI@^T|`HAAQ}ICLcV>D#eJLbcU)%J8qXS1YZ$+v&Kg==w~z`NFEhzldRCsN$Nr zG-Bl6kvi2?XuwXHW;?q0F#eG9#bBWB@C&iGLc0VQV6EFB|8g~gJ6`c8ptI-#HkA@4sz>8&catiWVZ#CY4e5N=1;l1FEj`*#!8Qq1b7VElM2#&}zEahY ztL6r`MQ_q{PEpd=7IuBG5_V&+upPWb&A1M~3h*&8F3~E(Ljr52Q=^dT76@LeUd3)f zQf*arsRjWo2^TPN485Q`iJ3i7js6m%^*W&3yH1&Sihfki= zb})FE!?Q}MjqN4ICvi=|a8fL$BgRma2OEERR1(3JQtBL#%k@j%(mD1B5_xIWqiru< zR4hnJO0~h35DkY{`VD>CfEhZ7?y;u!)h4HptsQAEwu}HDY-n`(v!aM>8Fe4Rd0I4vxzX=IIZI zbBW}pg(*->XI1)S5avShP3sCF@?R5=nwH9QPI-X0)eetLyKtnp@Mgm&mt zXb`5NpWf2@jM~%sE4n}+9yEVS3}hVBYJ6Wjqakn_kI;&mel%Ov=C73y;tncMfi(JjcPE*oa7h09$|_V7ZSJOrVW-F9((bc2o|S+arP;~ z-d4LaHdc>1ZlfW+vFyFX22#-KlA9X*z?(%Scsw(ta^dszJ@U>Y3f-%D@Cer{&hrUc zis5l?#fU+qSJYOGq#h!WQHYR0xTI?y;^H+faRb}1?zh&#y5Ya0N^_^T4`-wcPhgAqd2EG%M-;h;B#KmE1w7Gv z0p<5T3g0)}#r2qc;gU1R!#8)7jx5jyn%luMY71&KwuT&>gitjMFR@P$B-bp8J}}o2 zRP7S;T7v**Wd;U@_nPfwm3!m;Ot*otVp|37^dRxM<8~*yj6J$~$zt4!y+LVD0h&43 zX{hs*!5|v*v`GbKjB40{q`8xUQ~Jl#odtNzHDhj~af4_yjQ*VsF#1%M(H}-rSz#1D zW)+F&7CS5Pg4~fExEFaoT{&4+In26P1YLWVQu07Ke9~@uf}7Twocd*e{J&!XDYr!Q zY~BeVe}MXkq56o`rIfZ=Vf&0$jrzA)#{kWr6&r8Jz`kp{)E34O!W#BnfPDt_i_|pQ zL{dhSM3Ygn1{_q;MwD7A3Aum9$StYBYOv#4_~6D>u(FPRGJ#ae-}lyRDk1XyK)%>>Gm;XWtlOdJRf{ zo0<5tg)_0(lzcI*dux!Cvm>{`GU3yYLywB7;~5C^3eDIL0y7Ao2#TF04~3-oLG|Z& zt9;~043`Fu32Bu_Y`7i6h@Vo!A4?>hrAi6oKV}_%aw5 z84N(J%#<#y=AZi%#AjWklNgdR;h33-F(0~F5wVsR0}wiELC)~Ei08ZCC-l_KTpvo zEelzh8_FrNAvdcDiyTYzuIXkq?GBf|H_0+Zo;FvFzqJdzJF1suB8105`# zF8$Y`CBvA1tUwq`GXEx3l9Ktm1_c?(`~_Pw6HH`O8)!99+BvK+aycM>l;;c#UW7{t zPDX{pCgig6LS_Y}(qhQ-W4a@0YXotM$#?c34UztQ14JTuXNWYCywhwAd8e6u9NSgO zyS+QKyt|FQvApAN8m@CNGG&I1=0J$`3ZVzmx}tmYY~~DXc_}n0Q6hmh8;hA@v#ppZo)!A1!Ok-& zgo8x%kS)b0QK`sRr8j4Bf;N2r2=8XM6b;hD_tEI`qSHa)brGF+4B}7jp@%K>@r5PWe^GNu?vd#&gfuQS zJ>Q{2>no-6kUX%-C_e@n$o4(}i4z&oUq`=?M9Gy1DV6& z*i6cD#&VE=Hv%O8!g&nC6>P^3X9Wk|3T7ajl~c!Tc-IwtgadKNv_T2U^a+nn9WO&K zS|vvWcHLAtopvG~OL#0){Kx`jJ9&I_nK#UPY5;8nq)7QBCx;Vs^FRQs9| zHO0o73J$e8ctavIvju+gEU#zS1;-l3$4BK^L|Rfa3Xaikj1-d#UT)`mTDPdNYYGgm z{>fOl%JRk@@WyXQP}bW2e($=0!k+i~DjOKz9t*}SKkNmJ|B_)Gi6107#^DD-BJqP% zu#0P|y>6`!!R(hzHR@isR^(Cfebi;nOc~8T{=ZRE`p17j-`HQk-!|YcQ0De}Ly#Yr z=i!m1p-S4xSnh(#TJC~u+Z*s0yvH`WvaJsASntWcq33YE*l_u6I0&^~r@^kYuDE*h zoCbLa^L~SE<7_1x5W=4zXmY$APNDF+nBeaoPDW*gA469;D?Cp&ZHO21g!W`>fUs1| zC`ygu$v*pn44;GHkPSP9S%RXV#kok3$|8!|NUofQol-JnC30YtQ^pUZ8{mu+TCo;4 zqG`j*?^i&MWux9&#sz5}HKei4RPlM+!=Ayiirj^EYK37RC5uz;kDEY9O%L9^miyD} ztG7Xr#iq_?+*0Tr{sJm57Ds2Pp*S4!sn=xjJzE}pbI7PBgg<(xxIm8&1rfU z7`GHLt&L+2dA;J2D*-gJ!fH)`YS2O|4{3#8LcF(W3Z@vc=umzK*x-pndC@s)mgd(> zGVP1Ac-E z8pt_zp!gVX11-V(r*o0es8X+kv?dtKFz=Dmrrt#=BSN0D=x~-1JvMScAW|M}13L!Zv%Tc7VOGkREsb<6P8hb1ZToe-xzpdP2PZ(4R(HREbJ&#Q(G8O#?NSovCl0;7d+)(r??8$ThwJL-SZcvt=#Mk!)Vc)BdgMy?tY$>r7@vU%6rY zuYySHwLX6{tt(b}mauTrtfqcJ2WV$EI%@q!fTiy8vc<&{wS9J>&o)yGoYmPE5neraOLoV z8jZV8INqz#kT$-4jZ6=y;FEAzpGP(4>*lnzVR_ zjK=Ws0T62VVwKMWA*J-KUYfuG`_-_)0k(tT!WUtw{0xgGb>veW;MV3N$R~rW&^N%|GN->JW0C?KIag?sI=pt&|oqIbd;f>P~dRXE5=a z^cwUHly~ywF1eaDbdeEEQNApxj;qXSlya9RoWZG#dr6bG!Z_ztuhbnAAEvZRM`#hB zN;6fj-!kxk&(Y$cM!MWySI5@nR=NZd$!@VJZxF63SZCBR&jA|fG{Bia%S7r;P~%FY zX*L;klTk^5eg`wEkr5B9Lq>%6QzaP{U@g}DHhwNDAdyi4dTy4*p5 z_QWCJMF+o-_e{z2lAiEsqDx&sm1#xLIg@LCw{>YffdmU<;Y8W~3MaJB`55YtVEZ?3 zDk8M6<0kiNIPLUUSXDj)g;nwye2B3+lFvXAV7Pvb4JUmJ+alW|l5Cl9g)i&i0-VjL zA-JvM(A_ICrRZP@B6SdQoJ$RZ1Q}v7m5w1j&sx|mk)-DY%#Qx2`r~fM&kKeo4Fvz; zWX7dBfst(_o|FKSI%v+zW#SV<>Szez7RXmBb0f7AB#L7H81_JO(o217d1 zk|U8a&XPm3=hYE9P;SaABfP4jwd9-}cPzC0jS-!r1wXu>at$5TZK@4?RMckw_-@m; zF<9v~{a5sj-KP9)!*0`Jw8?B5@-h^CIZ9^qvGl^oR2u5`m26fuK7IQi(((Vtbo~5n zJ>$o{x18=m9Q3Xt(N$8#{h^Q=u&(OWrB!*M3$8G}W8l-EjvI{q*ncD5Kyt(r=k3@% z_W2;YE#Eyu2Ht?!BVixZPI8*Y@Ieex9zA|PeWRam$mEOsT?b)l+yG;LsyJs9SM2Gt9zq(( zRYF1NiM<@afr8wmHzA`^Qa_5gu5B7>oh+o*5Vz=vRkjptC-3NlBxL>+|`5|z14jRmm{QRad3<* zxEv&_$^%Ge#<@zRM752tFtyds!#*EcHGN-Sh=p6LNcHAxhUg30Cno{y9(hX>{7iI{ z46G>4I_B1ywd&gO0{T80x`&CQg>VNBxreKqop0C}z~r?{`s}&Xf0(Q9-#weo@*(Mo5VhOV}m;es0x)8 zFR49KfhfO-!VQ@#(oW&T^7pPuRTYu) zkI|_ZXrqZ7IdxphNDQM*A`K{(oVOGqM=^;WKjk)Rd?71ugm?JhBkxclEhPh^>3SeYb>NHCHd=ANuJU8xA?lYk}Qsl2@2fi<5V$B^1ZR(QKDGEL!$UQ49`fS zSb{#1D7FyxjS)IfqFD0`9L%zTQ9aXoa-*W2@_8p)QI2GpXKLTH_Dt`mZ|s@oZ|m{w zO5=Z{xr|TZ0M_LyJ6hHy&QFXg&P_jApKa>H&})!ikZyQx(5i1*E?@DMkeu|Am-Gkp zQeqJWs9r+tBE#-SK^ogln`PW$Szb=-iobI6H9Z?b>A^H<5NA@5j9u)tso5ZXJpfW)^*o6eA7_F z)e}EE(T4b1Z~e3aq633ydt3X$Q}D5#vd<7>M$)}B+0(5lmUC{tQbeBcA;(l5oR-uP zi84x2JI8U~6h&LIzq~Zme_DQV@q=^bSS3YecA)7X#**VmDE$~G1ykn*OVBuR<}S9Wou zJZaRWF0K}8&{@a^&a~3FFS|j5u6t2gq2wTN{#ChQ$&o5A3zB%(!`9wf8N>rs{R*-* zmJkzaQhCz&DT3C<2q06Lw7CKWk#gp5DE!^Fo?aI|w8=>sy3)bZ8^TMtgq64nx3At< ze&Um}H-e+M;bNXLOYYCDW62F)rApE?u@=65lPed|sV=lh^$y%<>n)v=+L<)K(%<$} z)2A%tG+bA*r%#Usr82-2l$7j7p#BI3*wY&XO{<|BZpYB~Z;b`HGSw`|zr>Ii3t|;W zB#|_dsb+O>O`gc6e?6Kq@PBoZT>5cBmhsri?%PKlF{QeExRpto+A1-Bx+X&9nn7 z4dbmJm`Qp-jS4#0fL&i6(q!33dQ4=4i8{&2$B#dLyx*+f&K=809R6;&djE`Mn!)x( zu_3=Vt$U*rzYc+12S*tTes2yJEI#amxI5?tDO8LNZxzl8`NLr7NDAc`mivRKG^*u( zh~Kpi-_E3@RKvGMN{_Tm+`&K0NI$Tikv_$}hX)Z&kcOCTJ*m6EH`D$Lh3$tApox62 zU3e!7u{Nn*j@Z5IAZFDa$seY#j~Dm#SiUc@Kkl{(AJrK5{3Ne*BeVZN zRfoD!W^YN7;&-#o6f+mXduiyoMKLU)@On8@?ie;5WOUjm(bW(y3QvCRJ~=p~8Ov{? zK>d3+tgM0ok8fDV1|#&=|R_SeV4ozfO9-2HvV-ALM^MDy^)$~vrN zb@15{I#ByTnwg>S$p%K%6!n^cih3m(e?RD37^u_~|2=(UO_9HCSW_%UnY#B=$M6CM z9oahshT(@5zLSFR-4q1=wjL1lVTE;{Hh4wcg&0#rqCSy5S0J4UJ@Ib&bUw3br5^fr zgh}os!RuOokQdwf!!C9d6G4nFdT;ul4u1fAP?W$gAnfPjIyQrp1EjsWP>*UdsXLuw z9XND|WdDF1vrR!9qwpHYr0>lqk%oD`0f+Q_JdZ}ZO@w4~CafOIZxS~GduUvR{Hk_e zaENBA+>1IUmdZbZ{QatbtjD2uhSe_R)ceb1AdmK@`>^pp2B*6PxrM`rQa zTPjlOa{|*pM$$d4!2`P;1Dg>$mvGA=0;4FuNAInk9+xC<886JxlWLH7P3y7PyMW^} z3ooyDxXT{**1pVR&SatpAEfTc9@!#xQECXdC8}3Z%W5WlC$yEuv=qzvwC=%DQIDr^ z3{uw1Vh8skw#P}mC#LW@PrYW2JkWBfRK|IhI9ObBr7@^8A$_>{{#H3u5dt&Pmj?cXt-B?S6UdU|;R~Gv)Wl56ELz2uZNy4(% z({a4%E4HvH6kfN7e}LmnpXi0(mVZc;hd;yz&OsK9UvBL6{IYmgLZ_S>EL^MDw_PDy z2Zt%kVj_tWx6wPjMaaa(c*m>bXBT+(w~9R~Lq%1!bw=#cC3J;T?+j&8Dt2?4 zJ(TPr1*TnvE_Vy|@_{tG%O23TO_Y4M zk^YuzqPmOw_%l?h4x5Ljs9pG1~RqCQ4>NqMAoQK~C-AjKx))izOMb z(i1b?WO@Gm^KpRh@5w%_va`M_Ppfr+aT;n30&cI&*K4&h!L9Vf-MJ^ZCc;0bDZNLw zYsR2!zbE@3S6SRfFo4%$q+e<`08>xw);W5C@j8BQ^IAQzAJGU%K~=5G+i+U7fH6IZ zUCCvD35*1F@T#{QT!kxF>~XueOu!V0Z8#1rcGtVjHqt*T76f9s07sF$PRnf&>GpC7 zPXHpnDQd@Fw;olmHi@NfgTfHSUe&J2T!J&omxDNvEV{Rf-E>k90f-vql%5)xX1f3k z;$?9I6`U|=bhmn~ip%%_9MstZ^bMWBwLtHHHq;t4bSN$EmGmcAbe859IH$D&M&xUv zdLOy%u-Mb~+UC$S0Ry$J4SvViX>y1={Um9}3&)P3IIgr;6Casnqt42)p17Uf&S%Qa6WruheT^AtltEPDw#!~!o_=030h9P^WA1D(xa z@xv^tCw}krw745Q*{r71lN2;Q^<9nI#39$jZSg9U|EpC$Sn(V95B}ZJh=}!fv751~ z{ETnH{b<~d)kcI&W)ih`rvOCGboWX;CnRS1|taDkAIGj zu9%@WNWI~92aXJgcRWlu=iqQ8~Bv}x$rfFi-fP!#|zu>@gjZDUBw|?XdKej ziy__5$TvWQbWKD^Ng+eZ9La}>`2ciC@%bSI@rM*27g7)%J9k6!05c41Oz{}`TUYG1 zIgC-U8#aIxdq9IMp@l@hCvj_+5chK_II_7EHBzSK!gu8g)3;|bEzam(xzfH&`+WS8 zgwXBzw$u}dVk~pD2$4bH2eGpj!8T;xfvB50rOMv|p%DXTtp7{`H-yx=laZJ{eb7+v~Li$S&$xQEbjhs&H zP*Ex?bhV|OP+OLYy=`n*9SEy .section { + text-align: left; +} + +div.footer { + width: 940px; + margin: 20px auto 30px auto; + font-size: 14px; + color: #888; + text-align: right; +} + +div.footer a { + color: #888; +} + +p.caption { + font-family: inherit; + font-size: inherit; +} + + +div.relations { + display: none; +} + + +div.sphinxsidebar a { + color: #444; + text-decoration: none; + border-bottom: 1px dotted #999; +} + +div.sphinxsidebar a:hover { + border-bottom: 1px solid #999; +} + +div.sphinxsidebarwrapper { + padding: 18px 10px; +} + +div.sphinxsidebarwrapper p.logo { + padding: 0; + margin: -10px 0 0 0px; + text-align: center; +} + +div.sphinxsidebarwrapper h1.logo { + margin-top: -10px; + text-align: center; + margin-bottom: 5px; + text-align: left; +} + +div.sphinxsidebarwrapper h1.logo-name { + margin-top: 0px; +} + +div.sphinxsidebarwrapper p.blurb { + margin-top: 0; + font-style: normal; +} + +div.sphinxsidebar h3, +div.sphinxsidebar h4 { + font-family: Georgia, serif; + color: #444; + font-size: 24px; + font-weight: normal; + margin: 0 0 5px 0; + padding: 0; +} + +div.sphinxsidebar h4 { + font-size: 20px; +} + +div.sphinxsidebar h3 a { + color: #444; +} + +div.sphinxsidebar p.logo a, +div.sphinxsidebar h3 a, +div.sphinxsidebar p.logo a:hover, +div.sphinxsidebar h3 a:hover { + border: none; +} + +div.sphinxsidebar p { + color: #555; + margin: 10px 0; +} + +div.sphinxsidebar ul { + margin: 10px 0; + padding: 0; + color: #000; +} + +div.sphinxsidebar ul li.toctree-l1 > a { + font-size: 120%; +} + +div.sphinxsidebar ul li.toctree-l2 > a { + font-size: 110%; +} + +div.sphinxsidebar input { + border: 1px solid #CCC; + font-family: Georgia, serif; + font-size: 1em; +} + +div.sphinxsidebar hr { + border: none; + height: 1px; + color: #AAA; + background: #AAA; + + text-align: left; + margin-left: 0; + width: 50%; +} + +div.sphinxsidebar .badge { + border-bottom: none; +} + +div.sphinxsidebar .badge:hover { + border-bottom: none; +} + +/* To address an issue with donation coming after search */ +div.sphinxsidebar h3.donation { + margin-top: 10px; +} + +/* -- body styles ----------------------------------------------------------- */ + +a { + color: #004B6B; + text-decoration: underline; +} + +a:hover { + color: #6D4100; + text-decoration: underline; +} + +div.body h1, +div.body h2, +div.body h3, +div.body h4, +div.body h5, +div.body h6 { + font-family: Georgia, serif; + font-weight: normal; + margin: 30px 0px 10px 0px; + padding: 0; +} + +div.body h1 { margin-top: 0; padding-top: 0; font-size: 240%; } +div.body h2 { font-size: 180%; } +div.body h3 { font-size: 150%; } +div.body h4 { font-size: 130%; } +div.body h5 { font-size: 100%; } +div.body h6 { font-size: 100%; } + +a.headerlink { + color: #DDD; + padding: 0 4px; + text-decoration: none; +} + +a.headerlink:hover { + color: #444; + background: #EAEAEA; +} + +div.body p, div.body dd, div.body li { + line-height: 1.4em; +} + +div.admonition { + margin: 20px 0px; + padding: 10px 30px; + background-color: #EEE; + border: 1px solid #CCC; +} + +div.admonition tt.xref, div.admonition code.xref, div.admonition a tt { + background-color: #FBFBFB; + border-bottom: 1px solid #fafafa; +} + +div.admonition p.admonition-title { + font-family: Georgia, serif; + font-weight: normal; + font-size: 24px; + margin: 0 0 10px 0; + padding: 0; + line-height: 1; +} + +div.admonition p.last { + margin-bottom: 0; +} + +div.highlight { + background-color: #fff; +} + +dt:target, .highlight { + background: #FAF3E8; +} + +div.warning { + background-color: #FCC; + border: 1px solid #FAA; +} + +div.danger { + background-color: #FCC; + border: 1px solid #FAA; + -moz-box-shadow: 2px 2px 4px #D52C2C; + -webkit-box-shadow: 2px 2px 4px #D52C2C; + box-shadow: 2px 2px 4px #D52C2C; +} + +div.error { + background-color: #FCC; + border: 1px solid #FAA; + -moz-box-shadow: 2px 2px 4px #D52C2C; + -webkit-box-shadow: 2px 2px 4px #D52C2C; + box-shadow: 2px 2px 4px #D52C2C; +} + +div.caution { + background-color: #FCC; + border: 1px solid #FAA; +} + +div.attention { + background-color: #FCC; + border: 1px solid #FAA; +} + +div.important { + background-color: #EEE; + border: 1px solid #CCC; +} + +div.note { + background-color: #EEE; + border: 1px solid #CCC; +} + +div.tip { + background-color: #EEE; + border: 1px solid #CCC; +} + +div.hint { + background-color: #EEE; + border: 1px solid #CCC; +} + +div.seealso { + background-color: #EEE; + border: 1px solid #CCC; +} + +div.topic { + background-color: #EEE; +} + +p.admonition-title { + display: inline; +} + +p.admonition-title:after { + content: ":"; +} + +pre, tt, code { + font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace; + font-size: 0.9em; +} + +.hll { + background-color: #FFC; + margin: 0 -12px; + padding: 0 12px; + display: block; +} + +img.screenshot { +} + +tt.descname, tt.descclassname, code.descname, code.descclassname { + font-size: 0.95em; +} + +tt.descname, code.descname { + padding-right: 0.08em; +} + +img.screenshot { + -moz-box-shadow: 2px 2px 4px #EEE; + -webkit-box-shadow: 2px 2px 4px #EEE; + box-shadow: 2px 2px 4px #EEE; +} + +table.docutils { + border: 1px solid #888; + -moz-box-shadow: 2px 2px 4px #EEE; + -webkit-box-shadow: 2px 2px 4px #EEE; + box-shadow: 2px 2px 4px #EEE; +} + +table.docutils td, table.docutils th { + border: 1px solid #888; + padding: 0.25em 0.7em; +} + +table.field-list, table.footnote { + border: none; + -moz-box-shadow: none; + -webkit-box-shadow: none; + box-shadow: none; +} + +table.footnote { + margin: 15px 0; + width: 100%; + border: 1px solid #EEE; + background: #FDFDFD; + font-size: 0.9em; +} + +table.footnote + table.footnote { + margin-top: -15px; + border-top: none; +} + +table.field-list th { + padding: 0 0.8em 0 0; +} + +table.field-list td { + padding: 0; +} + +table.field-list p { + margin-bottom: 0.8em; +} + +/* Cloned from + * https://github.com/sphinx-doc/sphinx/commit/ef60dbfce09286b20b7385333d63a60321784e68 + */ +.field-name { + -moz-hyphens: manual; + -ms-hyphens: manual; + -webkit-hyphens: manual; + hyphens: manual; +} + +table.footnote td.label { + width: .1px; + padding: 0.3em 0 0.3em 0.5em; +} + +table.footnote td { + padding: 0.3em 0.5em; +} + +dl { + margin-left: 0; + margin-right: 0; + margin-top: 0; + padding: 0; +} + +dl dd { + margin-left: 30px; +} + +blockquote { + margin: 0 0 0 30px; + padding: 0; +} + +ul, ol { + /* Matches the 30px from the narrow-screen "li > ul" selector below */ + margin: 10px 0 10px 30px; + padding: 0; +} + +pre { + background: #EEE; + padding: 7px 30px; + margin: 15px 0px; + line-height: 1.3em; +} + +div.viewcode-block:target { + background: #ffd; +} + +dl pre, blockquote pre, li pre { + margin-left: 0; + padding-left: 30px; +} + +tt, code { + background-color: #ecf0f3; + color: #222; + /* padding: 1px 2px; */ +} + +tt.xref, code.xref, a tt { + background-color: #FBFBFB; + border-bottom: 1px solid #fff; +} + +a.reference { + text-decoration: none; + border-bottom: 1px dotted #004B6B; +} + +/* Don't put an underline on images */ +a.image-reference, a.image-reference:hover { + border-bottom: none; +} + +a.reference:hover { + border-bottom: 1px solid #6D4100; +} + +a.footnote-reference { + text-decoration: none; + font-size: 0.7em; + vertical-align: top; + border-bottom: 1px dotted #004B6B; +} + +a.footnote-reference:hover { + border-bottom: 1px solid #6D4100; +} + +a:hover tt, a:hover code { + background: #EEE; +} + + +@media screen and (max-width: 870px) { + + div.sphinxsidebar { + display: none; + } + + div.document { + width: 100%; + + } + + div.documentwrapper { + margin-left: 0; + margin-top: 0; + margin-right: 0; + margin-bottom: 0; + } + + div.bodywrapper { + margin-top: 0; + margin-right: 0; + margin-bottom: 0; + margin-left: 0; + } + + ul { + margin-left: 0; + } + + li > ul { + /* Matches the 30px from the "ul, ol" selector above */ + margin-left: 30px; + } + + .document { + width: auto; + } + + .footer { + width: auto; + } + + .bodywrapper { + margin: 0; + } + + .footer { + width: auto; + } + + .github { + display: none; + } + + + +} + + + +@media screen and (max-width: 875px) { + + body { + margin: 0; + padding: 20px 30px; + } + + div.documentwrapper { + float: none; + background: #fff; + } + + div.sphinxsidebar { + display: block; + float: none; + width: 102.5%; + margin: 50px -30px -20px -30px; + padding: 10px 20px; + background: #333; + color: #FFF; + } + + div.sphinxsidebar h3, div.sphinxsidebar h4, div.sphinxsidebar p, + div.sphinxsidebar h3 a { + color: #fff; + } + + div.sphinxsidebar a { + color: #AAA; + } + + div.sphinxsidebar p.logo { + display: none; + } + + div.document { + width: 100%; + margin: 0; + } + + div.footer { + display: none; + } + + div.bodywrapper { + margin: 0; + } + + div.body { + min-height: 0; + padding: 0; + } + + .rtd_doc_footer { + display: none; + } + + .document { + width: auto; + } + + .footer { + width: auto; + } + + .footer { + width: auto; + } + + .github { + display: none; + } +} + + +/* misc. */ + +.revsys-inline { + display: none!important; +} + +/* Make nested-list/multi-paragraph items look better in Releases changelog + * pages. Without this, docutils' magical list fuckery causes inconsistent + * formatting between different release sub-lists. + */ +div#changelog > div.section > ul > li > p:only-child { + margin-bottom: 0; +} + +/* Hide fugly table cell borders in ..bibliography:: directive output */ +table.docutils.citation, table.docutils.citation td, table.docutils.citation th { + border: none; + /* Below needed in some edge cases; if not applied, bottom shadows appear */ + -moz-box-shadow: none; + -webkit-box-shadow: none; + box-shadow: none; +} + + +/* relbar */ + +.related { + line-height: 30px; + width: 100%; + font-size: 0.9rem; +} + +.related.top { + border-bottom: 1px solid #EEE; + margin-bottom: 20px; +} + +.related.bottom { + border-top: 1px solid #EEE; +} + +.related ul { + padding: 0; + margin: 0; + list-style: none; +} + +.related li { + display: inline; +} + +nav#rellinks { + float: right; +} + +nav#rellinks li+li:before { + content: "|"; +} + +nav#breadcrumbs li+li:before { + content: "\00BB"; +} + +/* Hide certain items when printing */ +@media print { + div.related { + display: none; + } +} \ No newline at end of file diff --git a/docs/build/html/_static/basic.css b/docs/build/html/_static/basic.css new file mode 100644 index 0000000..30fee9d --- /dev/null +++ b/docs/build/html/_static/basic.css @@ -0,0 +1,925 @@ +/* + * basic.css + * ~~~~~~~~~ + * + * Sphinx stylesheet -- basic theme. + * + * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +/* -- main layout ----------------------------------------------------------- */ + +div.clearer { + clear: both; +} + +div.section::after { + display: block; + content: ''; + clear: left; +} + +/* -- relbar ---------------------------------------------------------------- */ + +div.related { + width: 100%; + font-size: 90%; +} + +div.related h3 { + display: none; +} + +div.related ul { + margin: 0; + padding: 0 0 0 10px; + list-style: none; +} + +div.related li { + display: inline; +} + +div.related li.right { + float: right; + margin-right: 5px; +} + +/* -- sidebar --------------------------------------------------------------- */ + +div.sphinxsidebarwrapper { + padding: 10px 5px 0 10px; +} + +div.sphinxsidebar { + float: left; + width: 230px; + margin-left: -100%; + font-size: 90%; + word-wrap: break-word; + overflow-wrap : break-word; +} + +div.sphinxsidebar ul { + list-style: none; +} + +div.sphinxsidebar ul ul, +div.sphinxsidebar ul.want-points { + margin-left: 20px; + list-style: square; +} + +div.sphinxsidebar ul ul { + margin-top: 0; + margin-bottom: 0; +} + +div.sphinxsidebar form { + margin-top: 10px; +} + +div.sphinxsidebar input { + border: 1px solid #98dbcc; + font-family: sans-serif; + font-size: 1em; +} + +div.sphinxsidebar #searchbox form.search { + overflow: hidden; +} + +div.sphinxsidebar #searchbox input[type="text"] { + float: left; + width: 80%; + padding: 0.25em; + box-sizing: border-box; +} + +div.sphinxsidebar #searchbox input[type="submit"] { + float: left; + width: 20%; + border-left: none; + padding: 0.25em; + box-sizing: border-box; +} + + +img { + border: 0; + max-width: 100%; +} + +/* -- search page ----------------------------------------------------------- */ + +ul.search { + margin: 10px 0 0 20px; + padding: 0; +} + +ul.search li { + padding: 5px 0 5px 20px; + background-image: url(file.png); + background-repeat: no-repeat; + background-position: 0 7px; +} + +ul.search li a { + font-weight: bold; +} + +ul.search li p.context { + color: #888; + margin: 2px 0 0 30px; + text-align: left; +} + +ul.keywordmatches li.goodmatch a { + font-weight: bold; +} + +/* -- index page ------------------------------------------------------------ */ + +table.contentstable { + width: 90%; + margin-left: auto; + margin-right: auto; +} + +table.contentstable p.biglink { + line-height: 150%; +} + +a.biglink { + font-size: 1.3em; +} + +span.linkdescr { + font-style: italic; + padding-top: 5px; + font-size: 90%; +} + +/* -- general index --------------------------------------------------------- */ + +table.indextable { + width: 100%; +} + +table.indextable td { + text-align: left; + vertical-align: top; +} + +table.indextable ul { + margin-top: 0; + margin-bottom: 0; + list-style-type: none; +} + +table.indextable > tbody > tr > td > ul { + padding-left: 0em; +} + +table.indextable tr.pcap { + height: 10px; +} + +table.indextable tr.cap { + margin-top: 10px; + background-color: #f2f2f2; +} + +img.toggler { + margin-right: 3px; + margin-top: 3px; + cursor: pointer; +} + +div.modindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +div.genindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +/* -- domain module index --------------------------------------------------- */ + +table.modindextable td { + padding: 2px; + border-collapse: collapse; +} + +/* -- general body styles --------------------------------------------------- */ + +div.body { + min-width: 360px; + max-width: 800px; +} + +div.body p, div.body dd, div.body li, div.body blockquote { + -moz-hyphens: auto; + -ms-hyphens: auto; + -webkit-hyphens: auto; + hyphens: auto; +} + +a.headerlink { + visibility: hidden; +} + +a:visited { + color: #551A8B; +} + +h1:hover > a.headerlink, +h2:hover > a.headerlink, +h3:hover > a.headerlink, +h4:hover > a.headerlink, +h5:hover > a.headerlink, +h6:hover > a.headerlink, +dt:hover > a.headerlink, +caption:hover > a.headerlink, +p.caption:hover > a.headerlink, +div.code-block-caption:hover > a.headerlink { + visibility: visible; +} + +div.body p.caption { + text-align: inherit; +} + +div.body td { + text-align: left; +} + +.first { + margin-top: 0 !important; +} + +p.rubric { + margin-top: 30px; + font-weight: bold; +} + +img.align-left, figure.align-left, .figure.align-left, object.align-left { + clear: left; + float: left; + margin-right: 1em; +} + +img.align-right, figure.align-right, .figure.align-right, object.align-right { + clear: right; + float: right; + margin-left: 1em; +} + +img.align-center, figure.align-center, .figure.align-center, object.align-center { + display: block; + margin-left: auto; + margin-right: auto; +} + +img.align-default, figure.align-default, .figure.align-default { + display: block; + margin-left: auto; + margin-right: auto; +} + +.align-left { + text-align: left; +} + +.align-center { + text-align: center; +} + +.align-default { + text-align: center; +} + +.align-right { + text-align: right; +} + +/* -- sidebars -------------------------------------------------------------- */ + +div.sidebar, +aside.sidebar { + margin: 0 0 0.5em 1em; + border: 1px solid #ddb; + padding: 7px; + background-color: #ffe; + width: 40%; + float: right; + clear: right; + overflow-x: auto; +} + +p.sidebar-title { + font-weight: bold; +} + +nav.contents, +aside.topic, +div.admonition, div.topic, blockquote { + clear: left; +} + +/* -- topics ---------------------------------------------------------------- */ + +nav.contents, +aside.topic, +div.topic { + border: 1px solid #ccc; + padding: 7px; + margin: 10px 0 10px 0; +} + +p.topic-title { + font-size: 1.1em; + font-weight: bold; + margin-top: 10px; +} + +/* -- admonitions ----------------------------------------------------------- */ + +div.admonition { + margin-top: 10px; + margin-bottom: 10px; + padding: 7px; +} + +div.admonition dt { + font-weight: bold; +} + +p.admonition-title { + margin: 0px 10px 5px 0px; + font-weight: bold; +} + +div.body p.centered { + text-align: center; + margin-top: 25px; +} + +/* -- content of sidebars/topics/admonitions -------------------------------- */ + +div.sidebar > :last-child, +aside.sidebar > :last-child, +nav.contents > :last-child, +aside.topic > :last-child, +div.topic > :last-child, +div.admonition > :last-child { + margin-bottom: 0; +} + +div.sidebar::after, +aside.sidebar::after, +nav.contents::after, +aside.topic::after, +div.topic::after, +div.admonition::after, +blockquote::after { + display: block; + content: ''; + clear: both; +} + +/* -- tables ---------------------------------------------------------------- */ + +table.docutils { + margin-top: 10px; + margin-bottom: 10px; + border: 0; + border-collapse: collapse; +} + +table.align-center { + margin-left: auto; + margin-right: auto; +} + +table.align-default { + margin-left: auto; + margin-right: auto; +} + +table caption span.caption-number { + font-style: italic; +} + +table caption span.caption-text { +} + +table.docutils td, table.docutils th { + padding: 1px 8px 1px 5px; + border-top: 0; + border-left: 0; + border-right: 0; + border-bottom: 1px solid #aaa; +} + +th { + text-align: left; + padding-right: 5px; +} + +table.citation { + border-left: solid 1px gray; + margin-left: 1px; +} + +table.citation td { + border-bottom: none; +} + +th > :first-child, +td > :first-child { + margin-top: 0px; +} + +th > :last-child, +td > :last-child { + margin-bottom: 0px; +} + +/* -- figures --------------------------------------------------------------- */ + +div.figure, figure { + margin: 0.5em; + padding: 0.5em; +} + +div.figure p.caption, figcaption { + padding: 0.3em; +} + +div.figure p.caption span.caption-number, +figcaption span.caption-number { + font-style: italic; +} + +div.figure p.caption span.caption-text, +figcaption span.caption-text { +} + +/* -- field list styles ----------------------------------------------------- */ + +table.field-list td, table.field-list th { + border: 0 !important; +} + +.field-list ul { + margin: 0; + padding-left: 1em; +} + +.field-list p { + margin: 0; +} + +.field-name { + -moz-hyphens: manual; + -ms-hyphens: manual; + -webkit-hyphens: manual; + hyphens: manual; +} + +/* -- hlist styles ---------------------------------------------------------- */ + +table.hlist { + margin: 1em 0; +} + +table.hlist td { + vertical-align: top; +} + +/* -- object description styles --------------------------------------------- */ + +.sig { + font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace; +} + +.sig-name, code.descname { + background-color: transparent; + font-weight: bold; +} + +.sig-name { + font-size: 1.1em; +} + +code.descname { + font-size: 1.2em; +} + +.sig-prename, code.descclassname { + background-color: transparent; +} + +.optional { + font-size: 1.3em; +} + +.sig-paren { + font-size: larger; +} + +.sig-param.n { + font-style: italic; +} + +/* C++ specific styling */ + +.sig-inline.c-texpr, +.sig-inline.cpp-texpr { + font-family: unset; +} + +.sig.c .k, .sig.c .kt, +.sig.cpp .k, .sig.cpp .kt { + color: #0033B3; +} + +.sig.c .m, +.sig.cpp .m { + color: #1750EB; +} + +.sig.c .s, .sig.c .sc, +.sig.cpp .s, .sig.cpp .sc { + color: #067D17; +} + + +/* -- other body styles ----------------------------------------------------- */ + +ol.arabic { + list-style: decimal; +} + +ol.loweralpha { + list-style: lower-alpha; +} + +ol.upperalpha { + list-style: upper-alpha; +} + +ol.lowerroman { + list-style: lower-roman; +} + +ol.upperroman { + list-style: upper-roman; +} + +:not(li) > ol > li:first-child > :first-child, +:not(li) > ul > li:first-child > :first-child { + margin-top: 0px; +} + +:not(li) > ol > li:last-child > :last-child, +:not(li) > ul > li:last-child > :last-child { + margin-bottom: 0px; +} + +ol.simple ol p, +ol.simple ul p, +ul.simple ol p, +ul.simple ul p { + margin-top: 0; +} + +ol.simple > li:not(:first-child) > p, +ul.simple > li:not(:first-child) > p { + margin-top: 0; +} + +ol.simple p, +ul.simple p { + margin-bottom: 0; +} + +aside.footnote > span, +div.citation > span { + float: left; +} +aside.footnote > span:last-of-type, +div.citation > span:last-of-type { + padding-right: 0.5em; +} +aside.footnote > p { + margin-left: 2em; +} +div.citation > p { + margin-left: 4em; +} +aside.footnote > p:last-of-type, +div.citation > p:last-of-type { + margin-bottom: 0em; +} +aside.footnote > p:last-of-type:after, +div.citation > p:last-of-type:after { + content: ""; + clear: both; +} + +dl.field-list { + display: grid; + grid-template-columns: fit-content(30%) auto; +} + +dl.field-list > dt { + font-weight: bold; + word-break: break-word; + padding-left: 0.5em; + padding-right: 5px; +} + +dl.field-list > dd { + padding-left: 0.5em; + margin-top: 0em; + margin-left: 0em; + margin-bottom: 0em; +} + +dl { + margin-bottom: 15px; +} + +dd > :first-child { + margin-top: 0px; +} + +dd ul, dd table { + margin-bottom: 10px; +} + +dd { + margin-top: 3px; + margin-bottom: 10px; + margin-left: 30px; +} + +.sig dd { + margin-top: 0px; + margin-bottom: 0px; +} + +.sig dl { + margin-top: 0px; + margin-bottom: 0px; +} + +dl > dd:last-child, +dl > dd:last-child > :last-child { + margin-bottom: 0; +} + +dt:target, span.highlighted { + background-color: #fbe54e; +} + +rect.highlighted { + fill: #fbe54e; +} + +dl.glossary dt { + font-weight: bold; + font-size: 1.1em; +} + +.versionmodified { + font-style: italic; +} + +.system-message { + background-color: #fda; + padding: 5px; + border: 3px solid red; +} + +.footnote:target { + background-color: #ffa; +} + +.line-block { + display: block; + margin-top: 1em; + margin-bottom: 1em; +} + +.line-block .line-block { + margin-top: 0; + margin-bottom: 0; + margin-left: 1.5em; +} + +.guilabel, .menuselection { + font-family: sans-serif; +} + +.accelerator { + text-decoration: underline; +} + +.classifier { + font-style: oblique; +} + +.classifier:before { + font-style: normal; + margin: 0 0.5em; + content: ":"; + display: inline-block; +} + +abbr, acronym { + border-bottom: dotted 1px; + cursor: help; +} + +.translated { + background-color: rgba(207, 255, 207, 0.2) +} + +.untranslated { + background-color: rgba(255, 207, 207, 0.2) +} + +/* -- code displays --------------------------------------------------------- */ + +pre { + overflow: auto; + overflow-y: hidden; /* fixes display issues on Chrome browsers */ +} + +pre, div[class*="highlight-"] { + clear: both; +} + +span.pre { + -moz-hyphens: none; + -ms-hyphens: none; + -webkit-hyphens: none; + hyphens: none; + white-space: nowrap; +} + +div[class*="highlight-"] { + margin: 1em 0; +} + +td.linenos pre { + border: 0; + background-color: transparent; + color: #aaa; +} + +table.highlighttable { + display: block; +} + +table.highlighttable tbody { + display: block; +} + +table.highlighttable tr { + display: flex; +} + +table.highlighttable td { + margin: 0; + padding: 0; +} + +table.highlighttable td.linenos { + padding-right: 0.5em; +} + +table.highlighttable td.code { + flex: 1; + overflow: hidden; +} + +.highlight .hll { + display: block; +} + +div.highlight pre, +table.highlighttable pre { + margin: 0; +} + +div.code-block-caption + div { + margin-top: 0; +} + +div.code-block-caption { + margin-top: 1em; + padding: 2px 5px; + font-size: small; +} + +div.code-block-caption code { + background-color: transparent; +} + +table.highlighttable td.linenos, +span.linenos, +div.highlight span.gp { /* gp: Generic.Prompt */ + user-select: none; + -webkit-user-select: text; /* Safari fallback only */ + -webkit-user-select: none; /* Chrome/Safari */ + -moz-user-select: none; /* Firefox */ + -ms-user-select: none; /* IE10+ */ +} + +div.code-block-caption span.caption-number { + padding: 0.1em 0.3em; + font-style: italic; +} + +div.code-block-caption span.caption-text { +} + +div.literal-block-wrapper { + margin: 1em 0; +} + +code.xref, a code { + background-color: transparent; + font-weight: bold; +} + +h1 code, h2 code, h3 code, h4 code, h5 code, h6 code { + background-color: transparent; +} + +.viewcode-link { + float: right; +} + +.viewcode-back { + float: right; + font-family: sans-serif; +} + +div.viewcode-block:target { + margin: -1px -10px; + padding: 0 10px; +} + +/* -- math display ---------------------------------------------------------- */ + +img.math { + vertical-align: middle; +} + +div.body div.math p { + text-align: center; +} + +span.eqno { + float: right; +} + +span.eqno a.headerlink { + position: absolute; + z-index: 1; +} + +div.math:hover a.headerlink { + visibility: visible; +} + +/* -- printout stylesheet --------------------------------------------------- */ + +@media print { + div.document, + div.documentwrapper, + div.bodywrapper { + margin: 0 !important; + width: 100%; + } + + div.sphinxsidebar, + div.related, + div.footer, + #top-link { + display: none; + } +} \ No newline at end of file diff --git a/docs/build/html/_static/custom.css b/docs/build/html/_static/custom.css new file mode 100644 index 0000000..2a924f1 --- /dev/null +++ b/docs/build/html/_static/custom.css @@ -0,0 +1 @@ +/* This file intentionally left blank. */ diff --git a/docs/build/html/_static/doctools.js b/docs/build/html/_static/doctools.js new file mode 100644 index 0000000..d06a71d --- /dev/null +++ b/docs/build/html/_static/doctools.js @@ -0,0 +1,156 @@ +/* + * doctools.js + * ~~~~~~~~~~~ + * + * Base JavaScript utilities for all Sphinx HTML documentation. + * + * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ +"use strict"; + +const BLACKLISTED_KEY_CONTROL_ELEMENTS = new Set([ + "TEXTAREA", + "INPUT", + "SELECT", + "BUTTON", +]); + +const _ready = (callback) => { + if (document.readyState !== "loading") { + callback(); + } else { + document.addEventListener("DOMContentLoaded", callback); + } +}; + +/** + * Small JavaScript module for the documentation. + */ +const Documentation = { + init: () => { + Documentation.initDomainIndexTable(); + Documentation.initOnKeyListeners(); + }, + + /** + * i18n support + */ + TRANSLATIONS: {}, + PLURAL_EXPR: (n) => (n === 1 ? 0 : 1), + LOCALE: "unknown", + + // gettext and ngettext don't access this so that the functions + // can safely bound to a different name (_ = Documentation.gettext) + gettext: (string) => { + const translated = Documentation.TRANSLATIONS[string]; + switch (typeof translated) { + case "undefined": + return string; // no translation + case "string": + return translated; // translation exists + default: + return translated[0]; // (singular, plural) translation tuple exists + } + }, + + ngettext: (singular, plural, n) => { + const translated = Documentation.TRANSLATIONS[singular]; + if (typeof translated !== "undefined") + return translated[Documentation.PLURAL_EXPR(n)]; + return n === 1 ? singular : plural; + }, + + addTranslations: (catalog) => { + Object.assign(Documentation.TRANSLATIONS, catalog.messages); + Documentation.PLURAL_EXPR = new Function( + "n", + `return (${catalog.plural_expr})` + ); + Documentation.LOCALE = catalog.locale; + }, + + /** + * helper function to focus on search bar + */ + focusSearchBar: () => { + document.querySelectorAll("input[name=q]")[0]?.focus(); + }, + + /** + * Initialise the domain index toggle buttons + */ + initDomainIndexTable: () => { + const toggler = (el) => { + const idNumber = el.id.substr(7); + const toggledRows = document.querySelectorAll(`tr.cg-${idNumber}`); + if (el.src.substr(-9) === "minus.png") { + el.src = `${el.src.substr(0, el.src.length - 9)}plus.png`; + toggledRows.forEach((el) => (el.style.display = "none")); + } else { + el.src = `${el.src.substr(0, el.src.length - 8)}minus.png`; + toggledRows.forEach((el) => (el.style.display = "")); + } + }; + + const togglerElements = document.querySelectorAll("img.toggler"); + togglerElements.forEach((el) => + el.addEventListener("click", (event) => toggler(event.currentTarget)) + ); + togglerElements.forEach((el) => (el.style.display = "")); + if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) togglerElements.forEach(toggler); + }, + + initOnKeyListeners: () => { + // only install a listener if it is really needed + if ( + !DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS && + !DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS + ) + return; + + document.addEventListener("keydown", (event) => { + // bail for input elements + if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return; + // bail with special keys + if (event.altKey || event.ctrlKey || event.metaKey) return; + + if (!event.shiftKey) { + switch (event.key) { + case "ArrowLeft": + if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break; + + const prevLink = document.querySelector('link[rel="prev"]'); + if (prevLink && prevLink.href) { + window.location.href = prevLink.href; + event.preventDefault(); + } + break; + case "ArrowRight": + if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break; + + const nextLink = document.querySelector('link[rel="next"]'); + if (nextLink && nextLink.href) { + window.location.href = nextLink.href; + event.preventDefault(); + } + break; + } + } + + // some keyboard layouts may need Shift to get / + switch (event.key) { + case "/": + if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) break; + Documentation.focusSearchBar(); + event.preventDefault(); + } + }); + }, +}; + +// quick alias for translations +const _ = Documentation.gettext; + +_ready(Documentation.init); diff --git a/docs/build/html/_static/documentation_options.js b/docs/build/html/_static/documentation_options.js new file mode 100644 index 0000000..7e4c114 --- /dev/null +++ b/docs/build/html/_static/documentation_options.js @@ -0,0 +1,13 @@ +const DOCUMENTATION_OPTIONS = { + VERSION: '', + LANGUAGE: 'en', + COLLAPSE_INDEX: false, + BUILDER: 'html', + FILE_SUFFIX: '.html', + LINK_SUFFIX: '.html', + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '.txt', + NAVIGATION_WITH_KEYS: false, + SHOW_SEARCH_SUMMARY: true, + ENABLE_SEARCH_SHORTCUTS: true, +}; \ No newline at end of file diff --git a/docs/build/html/_static/file.png b/docs/build/html/_static/file.png new file mode 100644 index 0000000000000000000000000000000000000000..a858a410e4faa62ce324d814e4b816fff83a6fb3 GIT binary patch literal 286 zcmV+(0pb3MP)s`hMrGg#P~ix$^RISR_I47Y|r1 z_CyJOe}D1){SET-^Amu_i71Lt6eYfZjRyw@I6OQAIXXHDfiX^GbOlHe=Ae4>0m)d(f|Me07*qoM6N<$f}vM^LjV8( literal 0 HcmV?d00001 diff --git a/docs/build/html/_static/language_data.js b/docs/build/html/_static/language_data.js new file mode 100644 index 0000000..250f566 --- /dev/null +++ b/docs/build/html/_static/language_data.js @@ -0,0 +1,199 @@ +/* + * language_data.js + * ~~~~~~~~~~~~~~~~ + * + * This script contains the language-specific data used by searchtools.js, + * namely the list of stopwords, stemmer, scorer and splitter. + * + * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +var stopwords = ["a", "and", "are", "as", "at", "be", "but", "by", "for", "if", "in", "into", "is", "it", "near", "no", "not", "of", "on", "or", "such", "that", "the", "their", "then", "there", "these", "they", "this", "to", "was", "will", "with"]; + + +/* Non-minified version is copied as a separate JS file, is available */ + +/** + * Porter Stemmer + */ +var Stemmer = function() { + + var step2list = { + ational: 'ate', + tional: 'tion', + enci: 'ence', + anci: 'ance', + izer: 'ize', + bli: 'ble', + alli: 'al', + entli: 'ent', + eli: 'e', + ousli: 'ous', + ization: 'ize', + ation: 'ate', + ator: 'ate', + alism: 'al', + iveness: 'ive', + fulness: 'ful', + ousness: 'ous', + aliti: 'al', + iviti: 'ive', + biliti: 'ble', + logi: 'log' + }; + + var step3list = { + icate: 'ic', + ative: '', + alize: 'al', + iciti: 'ic', + ical: 'ic', + ful: '', + ness: '' + }; + + var c = "[^aeiou]"; // consonant + var v = "[aeiouy]"; // vowel + var C = c + "[^aeiouy]*"; // consonant sequence + var V = v + "[aeiou]*"; // vowel sequence + + var mgr0 = "^(" + C + ")?" + V + C; // [C]VC... is m>0 + var meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$"; // [C]VC[V] is m=1 + var mgr1 = "^(" + C + ")?" + V + C + V + C; // [C]VCVC... is m>1 + var s_v = "^(" + C + ")?" + v; // vowel in stem + + this.stemWord = function (w) { + var stem; + var suffix; + var firstch; + var origword = w; + + if (w.length < 3) + return w; + + var re; + var re2; + var re3; + var re4; + + firstch = w.substr(0,1); + if (firstch == "y") + w = firstch.toUpperCase() + w.substr(1); + + // Step 1a + re = /^(.+?)(ss|i)es$/; + re2 = /^(.+?)([^s])s$/; + + if (re.test(w)) + w = w.replace(re,"$1$2"); + else if (re2.test(w)) + w = w.replace(re2,"$1$2"); + + // Step 1b + re = /^(.+?)eed$/; + re2 = /^(.+?)(ed|ing)$/; + if (re.test(w)) { + var fp = re.exec(w); + re = new RegExp(mgr0); + if (re.test(fp[1])) { + re = /.$/; + w = w.replace(re,""); + } + } + else if (re2.test(w)) { + var fp = re2.exec(w); + stem = fp[1]; + re2 = new RegExp(s_v); + if (re2.test(stem)) { + w = stem; + re2 = /(at|bl|iz)$/; + re3 = new RegExp("([^aeiouylsz])\\1$"); + re4 = new RegExp("^" + C + v + "[^aeiouwxy]$"); + if (re2.test(w)) + w = w + "e"; + else if (re3.test(w)) { + re = /.$/; + w = w.replace(re,""); + } + else if (re4.test(w)) + w = w + "e"; + } + } + + // Step 1c + re = /^(.+?)y$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(s_v); + if (re.test(stem)) + w = stem + "i"; + } + + // Step 2 + re = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + suffix = fp[2]; + re = new RegExp(mgr0); + if (re.test(stem)) + w = stem + step2list[suffix]; + } + + // Step 3 + re = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + suffix = fp[2]; + re = new RegExp(mgr0); + if (re.test(stem)) + w = stem + step3list[suffix]; + } + + // Step 4 + re = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/; + re2 = /^(.+?)(s|t)(ion)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(mgr1); + if (re.test(stem)) + w = stem; + } + else if (re2.test(w)) { + var fp = re2.exec(w); + stem = fp[1] + fp[2]; + re2 = new RegExp(mgr1); + if (re2.test(stem)) + w = stem; + } + + // Step 5 + re = /^(.+?)e$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(mgr1); + re2 = new RegExp(meq1); + re3 = new RegExp("^" + C + v + "[^aeiouwxy]$"); + if (re.test(stem) || (re2.test(stem) && !(re3.test(stem)))) + w = stem; + } + re = /ll$/; + re2 = new RegExp(mgr1); + if (re.test(w) && re2.test(w)) { + re = /.$/; + w = w.replace(re,""); + } + + // and turn initial Y back to y + if (firstch == "y") + w = firstch.toLowerCase() + w.substr(1); + return w; + } +} + diff --git a/docs/build/html/_static/minus.png b/docs/build/html/_static/minus.png new file mode 100644 index 0000000000000000000000000000000000000000..d96755fdaf8bb2214971e0db9c1fd3077d7c419d GIT binary patch literal 90 zcmeAS@N?(olHy`uVBq!ia0vp^+#t*WBp7;*Yy1LIik>cxAr*|t7R?Mi>2?kWtu=nj kDsEF_5m^0CR;1wuP-*O&G^0G}KYk!hp00i_>zopr08q^qX#fBK literal 0 HcmV?d00001 diff --git a/docs/build/html/_static/plus.png b/docs/build/html/_static/plus.png new file mode 100644 index 0000000000000000000000000000000000000000..7107cec93a979b9a5f64843235a16651d563ce2d GIT binary patch literal 90 zcmeAS@N?(olHy`uVBq!ia0vp^+#t*WBp7;*Yy1LIik>cxAr*|t7R?Mi>2?kWtu>-2 m3q%Vub%g%s<8sJhVPMczOq}xhg9DJoz~JfX=d#Wzp$Pyb1r*Kz literal 0 HcmV?d00001 diff --git a/docs/build/html/_static/pygments.css b/docs/build/html/_static/pygments.css new file mode 100644 index 0000000..57c7df3 --- /dev/null +++ b/docs/build/html/_static/pygments.css @@ -0,0 +1,84 @@ +pre { line-height: 125%; } +td.linenos .normal { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; } +span.linenos { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; } +td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } +span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } +.highlight .hll { background-color: #ffffcc } +.highlight { background: #f8f8f8; } +.highlight .c { color: #8f5902; font-style: italic } /* Comment */ +.highlight .err { color: #a40000; border: 1px solid #ef2929 } /* Error */ +.highlight .g { color: #000000 } /* Generic */ +.highlight .k { color: #004461; font-weight: bold } /* Keyword */ +.highlight .l { color: #000000 } /* Literal */ +.highlight .n { color: #000000 } /* Name */ +.highlight .o { color: #582800 } /* Operator */ +.highlight .x { color: #000000 } /* Other */ +.highlight .p { color: #000000; font-weight: bold } /* Punctuation */ +.highlight .ch { color: #8f5902; font-style: italic } /* Comment.Hashbang */ +.highlight .cm { color: #8f5902; font-style: italic } /* Comment.Multiline */ +.highlight .cp { color: #8f5902 } /* Comment.Preproc */ +.highlight .cpf { color: #8f5902; font-style: italic } /* Comment.PreprocFile */ +.highlight .c1 { color: #8f5902; font-style: italic } /* Comment.Single */ +.highlight .cs { color: #8f5902; font-style: italic } /* Comment.Special */ +.highlight .gd { color: #a40000 } /* Generic.Deleted */ +.highlight .ge { color: #000000; font-style: italic } /* Generic.Emph */ +.highlight .ges { color: #000000 } /* Generic.EmphStrong */ +.highlight .gr { color: #ef2929 } /* Generic.Error */ +.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */ +.highlight .gi { color: #00A000 } /* Generic.Inserted */ +.highlight .go { color: #888888 } /* Generic.Output */ +.highlight .gp { color: #745334 } /* Generic.Prompt */ +.highlight .gs { color: #000000; font-weight: bold } /* Generic.Strong */ +.highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */ +.highlight .gt { color: #a40000; font-weight: bold } /* Generic.Traceback */ +.highlight .kc { color: #004461; font-weight: bold } /* Keyword.Constant */ +.highlight .kd { color: #004461; font-weight: bold } /* Keyword.Declaration */ +.highlight .kn { color: #004461; font-weight: bold } /* Keyword.Namespace */ +.highlight .kp { color: #004461; font-weight: bold } /* Keyword.Pseudo */ +.highlight .kr { color: #004461; font-weight: bold } /* Keyword.Reserved */ +.highlight .kt { color: #004461; font-weight: bold } /* Keyword.Type */ +.highlight .ld { color: #000000 } /* Literal.Date */ +.highlight .m { color: #990000 } /* Literal.Number */ +.highlight .s { color: #4e9a06 } /* Literal.String */ +.highlight .na { color: #c4a000 } /* Name.Attribute */ +.highlight .nb { color: #004461 } /* Name.Builtin */ +.highlight .nc { color: #000000 } /* Name.Class */ +.highlight .no { color: #000000 } /* Name.Constant */ +.highlight .nd { color: #888888 } /* Name.Decorator */ +.highlight .ni { color: #ce5c00 } /* Name.Entity */ +.highlight .ne { color: #cc0000; font-weight: bold } /* Name.Exception */ +.highlight .nf { color: #000000 } /* Name.Function */ +.highlight .nl { color: #f57900 } /* Name.Label */ +.highlight .nn { color: #000000 } /* Name.Namespace */ +.highlight .nx { color: #000000 } /* Name.Other */ +.highlight .py { color: #000000 } /* Name.Property */ +.highlight .nt { color: #004461; font-weight: bold } /* Name.Tag */ +.highlight .nv { color: #000000 } /* Name.Variable */ +.highlight .ow { color: #004461; font-weight: bold } /* Operator.Word */ +.highlight .pm { color: #000000; font-weight: bold } /* Punctuation.Marker */ +.highlight .w { color: #f8f8f8; text-decoration: underline } /* Text.Whitespace */ +.highlight .mb { color: #990000 } /* Literal.Number.Bin */ +.highlight .mf { color: #990000 } /* Literal.Number.Float */ +.highlight .mh { color: #990000 } /* Literal.Number.Hex */ +.highlight .mi { color: #990000 } /* Literal.Number.Integer */ +.highlight .mo { color: #990000 } /* Literal.Number.Oct */ +.highlight .sa { color: #4e9a06 } /* Literal.String.Affix */ +.highlight .sb { color: #4e9a06 } /* Literal.String.Backtick */ +.highlight .sc { color: #4e9a06 } /* Literal.String.Char */ +.highlight .dl { color: #4e9a06 } /* Literal.String.Delimiter */ +.highlight .sd { color: #8f5902; font-style: italic } /* Literal.String.Doc */ +.highlight .s2 { color: #4e9a06 } /* Literal.String.Double */ +.highlight .se { color: #4e9a06 } /* Literal.String.Escape */ +.highlight .sh { color: #4e9a06 } /* Literal.String.Heredoc */ +.highlight .si { color: #4e9a06 } /* Literal.String.Interpol */ +.highlight .sx { color: #4e9a06 } /* Literal.String.Other */ +.highlight .sr { color: #4e9a06 } /* Literal.String.Regex */ +.highlight .s1 { color: #4e9a06 } /* Literal.String.Single */ +.highlight .ss { color: #4e9a06 } /* Literal.String.Symbol */ +.highlight .bp { color: #3465a4 } /* Name.Builtin.Pseudo */ +.highlight .fm { color: #000000 } /* Name.Function.Magic */ +.highlight .vc { color: #000000 } /* Name.Variable.Class */ +.highlight .vg { color: #000000 } /* Name.Variable.Global */ +.highlight .vi { color: #000000 } /* Name.Variable.Instance */ +.highlight .vm { color: #000000 } /* Name.Variable.Magic */ +.highlight .il { color: #990000 } /* Literal.Number.Integer.Long */ \ No newline at end of file diff --git a/docs/build/html/_static/searchtools.js b/docs/build/html/_static/searchtools.js new file mode 100644 index 0000000..7918c3f --- /dev/null +++ b/docs/build/html/_static/searchtools.js @@ -0,0 +1,574 @@ +/* + * searchtools.js + * ~~~~~~~~~~~~~~~~ + * + * Sphinx JavaScript utilities for the full-text search. + * + * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ +"use strict"; + +/** + * Simple result scoring code. + */ +if (typeof Scorer === "undefined") { + var Scorer = { + // Implement the following function to further tweak the score for each result + // The function takes a result array [docname, title, anchor, descr, score, filename] + // and returns the new score. + /* + score: result => { + const [docname, title, anchor, descr, score, filename] = result + return score + }, + */ + + // query matches the full name of an object + objNameMatch: 11, + // or matches in the last dotted part of the object name + objPartialMatch: 6, + // Additive scores depending on the priority of the object + objPrio: { + 0: 15, // used to be importantResults + 1: 5, // used to be objectResults + 2: -5, // used to be unimportantResults + }, + // Used when the priority is not in the mapping. + objPrioDefault: 0, + + // query found in title + title: 15, + partialTitle: 7, + // query found in terms + term: 5, + partialTerm: 2, + }; +} + +const _removeChildren = (element) => { + while (element && element.lastChild) element.removeChild(element.lastChild); +}; + +/** + * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions#escaping + */ +const _escapeRegExp = (string) => + string.replace(/[.*+\-?^${}()|[\]\\]/g, "\\$&"); // $& means the whole matched string + +const _displayItem = (item, searchTerms, highlightTerms) => { + const docBuilder = DOCUMENTATION_OPTIONS.BUILDER; + const docFileSuffix = DOCUMENTATION_OPTIONS.FILE_SUFFIX; + const docLinkSuffix = DOCUMENTATION_OPTIONS.LINK_SUFFIX; + const showSearchSummary = DOCUMENTATION_OPTIONS.SHOW_SEARCH_SUMMARY; + const contentRoot = document.documentElement.dataset.content_root; + + const [docName, title, anchor, descr, score, _filename] = item; + + let listItem = document.createElement("li"); + let requestUrl; + let linkUrl; + if (docBuilder === "dirhtml") { + // dirhtml builder + let dirname = docName + "/"; + if (dirname.match(/\/index\/$/)) + dirname = dirname.substring(0, dirname.length - 6); + else if (dirname === "index/") dirname = ""; + requestUrl = contentRoot + dirname; + linkUrl = requestUrl; + } else { + // normal html builders + requestUrl = contentRoot + docName + docFileSuffix; + linkUrl = docName + docLinkSuffix; + } + let linkEl = listItem.appendChild(document.createElement("a")); + linkEl.href = linkUrl + anchor; + linkEl.dataset.score = score; + linkEl.innerHTML = title; + if (descr) { + listItem.appendChild(document.createElement("span")).innerHTML = + " (" + descr + ")"; + // highlight search terms in the description + if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js + highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted")); + } + else if (showSearchSummary) + fetch(requestUrl) + .then((responseData) => responseData.text()) + .then((data) => { + if (data) + listItem.appendChild( + Search.makeSearchSummary(data, searchTerms) + ); + // highlight search terms in the summary + if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js + highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted")); + }); + Search.output.appendChild(listItem); +}; +const _finishSearch = (resultCount) => { + Search.stopPulse(); + Search.title.innerText = _("Search Results"); + if (!resultCount) + Search.status.innerText = Documentation.gettext( + "Your search did not match any documents. Please make sure that all words are spelled correctly and that you've selected enough categories." + ); + else + Search.status.innerText = _( + `Search finished, found ${resultCount} page(s) matching the search query.` + ); +}; +const _displayNextItem = ( + results, + resultCount, + searchTerms, + highlightTerms, +) => { + // results left, load the summary and display it + // this is intended to be dynamic (don't sub resultsCount) + if (results.length) { + _displayItem(results.pop(), searchTerms, highlightTerms); + setTimeout( + () => _displayNextItem(results, resultCount, searchTerms, highlightTerms), + 5 + ); + } + // search finished, update title and status message + else _finishSearch(resultCount); +}; + +/** + * Default splitQuery function. Can be overridden in ``sphinx.search`` with a + * custom function per language. + * + * The regular expression works by splitting the string on consecutive characters + * that are not Unicode letters, numbers, underscores, or emoji characters. + * This is the same as ``\W+`` in Python, preserving the surrogate pair area. + */ +if (typeof splitQuery === "undefined") { + var splitQuery = (query) => query + .split(/[^\p{Letter}\p{Number}_\p{Emoji_Presentation}]+/gu) + .filter(term => term) // remove remaining empty strings +} + +/** + * Search Module + */ +const Search = { + _index: null, + _queued_query: null, + _pulse_status: -1, + + htmlToText: (htmlString) => { + const htmlElement = new DOMParser().parseFromString(htmlString, 'text/html'); + htmlElement.querySelectorAll(".headerlink").forEach((el) => { el.remove() }); + const docContent = htmlElement.querySelector('[role="main"]'); + if (docContent !== undefined) return docContent.textContent; + console.warn( + "Content block not found. Sphinx search tries to obtain it via '[role=main]'. Could you check your theme or template." + ); + return ""; + }, + + init: () => { + const query = new URLSearchParams(window.location.search).get("q"); + document + .querySelectorAll('input[name="q"]') + .forEach((el) => (el.value = query)); + if (query) Search.performSearch(query); + }, + + loadIndex: (url) => + (document.body.appendChild(document.createElement("script")).src = url), + + setIndex: (index) => { + Search._index = index; + if (Search._queued_query !== null) { + const query = Search._queued_query; + Search._queued_query = null; + Search.query(query); + } + }, + + hasIndex: () => Search._index !== null, + + deferQuery: (query) => (Search._queued_query = query), + + stopPulse: () => (Search._pulse_status = -1), + + startPulse: () => { + if (Search._pulse_status >= 0) return; + + const pulse = () => { + Search._pulse_status = (Search._pulse_status + 1) % 4; + Search.dots.innerText = ".".repeat(Search._pulse_status); + if (Search._pulse_status >= 0) window.setTimeout(pulse, 500); + }; + pulse(); + }, + + /** + * perform a search for something (or wait until index is loaded) + */ + performSearch: (query) => { + // create the required interface elements + const searchText = document.createElement("h2"); + searchText.textContent = _("Searching"); + const searchSummary = document.createElement("p"); + searchSummary.classList.add("search-summary"); + searchSummary.innerText = ""; + const searchList = document.createElement("ul"); + searchList.classList.add("search"); + + const out = document.getElementById("search-results"); + Search.title = out.appendChild(searchText); + Search.dots = Search.title.appendChild(document.createElement("span")); + Search.status = out.appendChild(searchSummary); + Search.output = out.appendChild(searchList); + + const searchProgress = document.getElementById("search-progress"); + // Some themes don't use the search progress node + if (searchProgress) { + searchProgress.innerText = _("Preparing search..."); + } + Search.startPulse(); + + // index already loaded, the browser was quick! + if (Search.hasIndex()) Search.query(query); + else Search.deferQuery(query); + }, + + /** + * execute search (requires search index to be loaded) + */ + query: (query) => { + const filenames = Search._index.filenames; + const docNames = Search._index.docnames; + const titles = Search._index.titles; + const allTitles = Search._index.alltitles; + const indexEntries = Search._index.indexentries; + + // stem the search terms and add them to the correct list + const stemmer = new Stemmer(); + const searchTerms = new Set(); + const excludedTerms = new Set(); + const highlightTerms = new Set(); + const objectTerms = new Set(splitQuery(query.toLowerCase().trim())); + splitQuery(query.trim()).forEach((queryTerm) => { + const queryTermLower = queryTerm.toLowerCase(); + + // maybe skip this "word" + // stopwords array is from language_data.js + if ( + stopwords.indexOf(queryTermLower) !== -1 || + queryTerm.match(/^\d+$/) + ) + return; + + // stem the word + let word = stemmer.stemWord(queryTermLower); + // select the correct list + if (word[0] === "-") excludedTerms.add(word.substr(1)); + else { + searchTerms.add(word); + highlightTerms.add(queryTermLower); + } + }); + + if (SPHINX_HIGHLIGHT_ENABLED) { // set in sphinx_highlight.js + localStorage.setItem("sphinx_highlight_terms", [...highlightTerms].join(" ")) + } + + // console.debug("SEARCH: searching for:"); + // console.info("required: ", [...searchTerms]); + // console.info("excluded: ", [...excludedTerms]); + + // array of [docname, title, anchor, descr, score, filename] + let results = []; + _removeChildren(document.getElementById("search-progress")); + + const queryLower = query.toLowerCase(); + for (const [title, foundTitles] of Object.entries(allTitles)) { + if (title.toLowerCase().includes(queryLower) && (queryLower.length >= title.length/2)) { + for (const [file, id] of foundTitles) { + let score = Math.round(100 * queryLower.length / title.length) + results.push([ + docNames[file], + titles[file] !== title ? `${titles[file]} > ${title}` : title, + id !== null ? "#" + id : "", + null, + score, + filenames[file], + ]); + } + } + } + + // search for explicit entries in index directives + for (const [entry, foundEntries] of Object.entries(indexEntries)) { + if (entry.includes(queryLower) && (queryLower.length >= entry.length/2)) { + for (const [file, id] of foundEntries) { + let score = Math.round(100 * queryLower.length / entry.length) + results.push([ + docNames[file], + titles[file], + id ? "#" + id : "", + null, + score, + filenames[file], + ]); + } + } + } + + // lookup as object + objectTerms.forEach((term) => + results.push(...Search.performObjectSearch(term, objectTerms)) + ); + + // lookup as search terms in fulltext + results.push(...Search.performTermsSearch(searchTerms, excludedTerms)); + + // let the scorer override scores with a custom scoring function + if (Scorer.score) results.forEach((item) => (item[4] = Scorer.score(item))); + + // now sort the results by score (in opposite order of appearance, since the + // display function below uses pop() to retrieve items) and then + // alphabetically + results.sort((a, b) => { + const leftScore = a[4]; + const rightScore = b[4]; + if (leftScore === rightScore) { + // same score: sort alphabetically + const leftTitle = a[1].toLowerCase(); + const rightTitle = b[1].toLowerCase(); + if (leftTitle === rightTitle) return 0; + return leftTitle > rightTitle ? -1 : 1; // inverted is intentional + } + return leftScore > rightScore ? 1 : -1; + }); + + // remove duplicate search results + // note the reversing of results, so that in the case of duplicates, the highest-scoring entry is kept + let seen = new Set(); + results = results.reverse().reduce((acc, result) => { + let resultStr = result.slice(0, 4).concat([result[5]]).map(v => String(v)).join(','); + if (!seen.has(resultStr)) { + acc.push(result); + seen.add(resultStr); + } + return acc; + }, []); + + results = results.reverse(); + + // for debugging + //Search.lastresults = results.slice(); // a copy + // console.info("search results:", Search.lastresults); + + // print the results + _displayNextItem(results, results.length, searchTerms, highlightTerms); + }, + + /** + * search for object names + */ + performObjectSearch: (object, objectTerms) => { + const filenames = Search._index.filenames; + const docNames = Search._index.docnames; + const objects = Search._index.objects; + const objNames = Search._index.objnames; + const titles = Search._index.titles; + + const results = []; + + const objectSearchCallback = (prefix, match) => { + const name = match[4] + const fullname = (prefix ? prefix + "." : "") + name; + const fullnameLower = fullname.toLowerCase(); + if (fullnameLower.indexOf(object) < 0) return; + + let score = 0; + const parts = fullnameLower.split("."); + + // check for different match types: exact matches of full name or + // "last name" (i.e. last dotted part) + if (fullnameLower === object || parts.slice(-1)[0] === object) + score += Scorer.objNameMatch; + else if (parts.slice(-1)[0].indexOf(object) > -1) + score += Scorer.objPartialMatch; // matches in last name + + const objName = objNames[match[1]][2]; + const title = titles[match[0]]; + + // If more than one term searched for, we require other words to be + // found in the name/title/description + const otherTerms = new Set(objectTerms); + otherTerms.delete(object); + if (otherTerms.size > 0) { + const haystack = `${prefix} ${name} ${objName} ${title}`.toLowerCase(); + if ( + [...otherTerms].some((otherTerm) => haystack.indexOf(otherTerm) < 0) + ) + return; + } + + let anchor = match[3]; + if (anchor === "") anchor = fullname; + else if (anchor === "-") anchor = objNames[match[1]][1] + "-" + fullname; + + const descr = objName + _(", in ") + title; + + // add custom score for some objects according to scorer + if (Scorer.objPrio.hasOwnProperty(match[2])) + score += Scorer.objPrio[match[2]]; + else score += Scorer.objPrioDefault; + + results.push([ + docNames[match[0]], + fullname, + "#" + anchor, + descr, + score, + filenames[match[0]], + ]); + }; + Object.keys(objects).forEach((prefix) => + objects[prefix].forEach((array) => + objectSearchCallback(prefix, array) + ) + ); + return results; + }, + + /** + * search for full-text terms in the index + */ + performTermsSearch: (searchTerms, excludedTerms) => { + // prepare search + const terms = Search._index.terms; + const titleTerms = Search._index.titleterms; + const filenames = Search._index.filenames; + const docNames = Search._index.docnames; + const titles = Search._index.titles; + + const scoreMap = new Map(); + const fileMap = new Map(); + + // perform the search on the required terms + searchTerms.forEach((word) => { + const files = []; + const arr = [ + { files: terms[word], score: Scorer.term }, + { files: titleTerms[word], score: Scorer.title }, + ]; + // add support for partial matches + if (word.length > 2) { + const escapedWord = _escapeRegExp(word); + Object.keys(terms).forEach((term) => { + if (term.match(escapedWord) && !terms[word]) + arr.push({ files: terms[term], score: Scorer.partialTerm }); + }); + Object.keys(titleTerms).forEach((term) => { + if (term.match(escapedWord) && !titleTerms[word]) + arr.push({ files: titleTerms[word], score: Scorer.partialTitle }); + }); + } + + // no match but word was a required one + if (arr.every((record) => record.files === undefined)) return; + + // found search word in contents + arr.forEach((record) => { + if (record.files === undefined) return; + + let recordFiles = record.files; + if (recordFiles.length === undefined) recordFiles = [recordFiles]; + files.push(...recordFiles); + + // set score for the word in each file + recordFiles.forEach((file) => { + if (!scoreMap.has(file)) scoreMap.set(file, {}); + scoreMap.get(file)[word] = record.score; + }); + }); + + // create the mapping + files.forEach((file) => { + if (fileMap.has(file) && fileMap.get(file).indexOf(word) === -1) + fileMap.get(file).push(word); + else fileMap.set(file, [word]); + }); + }); + + // now check if the files don't contain excluded terms + const results = []; + for (const [file, wordList] of fileMap) { + // check if all requirements are matched + + // as search terms with length < 3 are discarded + const filteredTermCount = [...searchTerms].filter( + (term) => term.length > 2 + ).length; + if ( + wordList.length !== searchTerms.size && + wordList.length !== filteredTermCount + ) + continue; + + // ensure that none of the excluded terms is in the search result + if ( + [...excludedTerms].some( + (term) => + terms[term] === file || + titleTerms[term] === file || + (terms[term] || []).includes(file) || + (titleTerms[term] || []).includes(file) + ) + ) + break; + + // select one (max) score for the file. + const score = Math.max(...wordList.map((w) => scoreMap.get(file)[w])); + // add result to the result list + results.push([ + docNames[file], + titles[file], + "", + null, + score, + filenames[file], + ]); + } + return results; + }, + + /** + * helper function to return a node containing the + * search summary for a given text. keywords is a list + * of stemmed words. + */ + makeSearchSummary: (htmlText, keywords) => { + const text = Search.htmlToText(htmlText); + if (text === "") return null; + + const textLower = text.toLowerCase(); + const actualStartPosition = [...keywords] + .map((k) => textLower.indexOf(k.toLowerCase())) + .filter((i) => i > -1) + .slice(-1)[0]; + const startWithContext = Math.max(actualStartPosition - 120, 0); + + const top = startWithContext === 0 ? "" : "..."; + const tail = startWithContext + 240 < text.length ? "..." : ""; + + let summary = document.createElement("p"); + summary.classList.add("context"); + summary.textContent = top + text.substr(startWithContext, 240).trim() + tail; + + return summary; + }, +}; + +_ready(Search.init); diff --git a/docs/build/html/_static/sphinx_highlight.js b/docs/build/html/_static/sphinx_highlight.js new file mode 100644 index 0000000..8a96c69 --- /dev/null +++ b/docs/build/html/_static/sphinx_highlight.js @@ -0,0 +1,154 @@ +/* Highlighting utilities for Sphinx HTML documentation. */ +"use strict"; + +const SPHINX_HIGHLIGHT_ENABLED = true + +/** + * highlight a given string on a node by wrapping it in + * span elements with the given class name. + */ +const _highlight = (node, addItems, text, className) => { + if (node.nodeType === Node.TEXT_NODE) { + const val = node.nodeValue; + const parent = node.parentNode; + const pos = val.toLowerCase().indexOf(text); + if ( + pos >= 0 && + !parent.classList.contains(className) && + !parent.classList.contains("nohighlight") + ) { + let span; + + const closestNode = parent.closest("body, svg, foreignObject"); + const isInSVG = closestNode && closestNode.matches("svg"); + if (isInSVG) { + span = document.createElementNS("http://www.w3.org/2000/svg", "tspan"); + } else { + span = document.createElement("span"); + span.classList.add(className); + } + + span.appendChild(document.createTextNode(val.substr(pos, text.length))); + const rest = document.createTextNode(val.substr(pos + text.length)); + parent.insertBefore( + span, + parent.insertBefore( + rest, + node.nextSibling + ) + ); + node.nodeValue = val.substr(0, pos); + /* There may be more occurrences of search term in this node. So call this + * function recursively on the remaining fragment. + */ + _highlight(rest, addItems, text, className); + + if (isInSVG) { + const rect = document.createElementNS( + "http://www.w3.org/2000/svg", + "rect" + ); + const bbox = parent.getBBox(); + rect.x.baseVal.value = bbox.x; + rect.y.baseVal.value = bbox.y; + rect.width.baseVal.value = bbox.width; + rect.height.baseVal.value = bbox.height; + rect.setAttribute("class", className); + addItems.push({ parent: parent, target: rect }); + } + } + } else if (node.matches && !node.matches("button, select, textarea")) { + node.childNodes.forEach((el) => _highlight(el, addItems, text, className)); + } +}; +const _highlightText = (thisNode, text, className) => { + let addItems = []; + _highlight(thisNode, addItems, text, className); + addItems.forEach((obj) => + obj.parent.insertAdjacentElement("beforebegin", obj.target) + ); +}; + +/** + * Small JavaScript module for the documentation. + */ +const SphinxHighlight = { + + /** + * highlight the search words provided in localstorage in the text + */ + highlightSearchWords: () => { + if (!SPHINX_HIGHLIGHT_ENABLED) return; // bail if no highlight + + // get and clear terms from localstorage + const url = new URL(window.location); + const highlight = + localStorage.getItem("sphinx_highlight_terms") + || url.searchParams.get("highlight") + || ""; + localStorage.removeItem("sphinx_highlight_terms") + url.searchParams.delete("highlight"); + window.history.replaceState({}, "", url); + + // get individual terms from highlight string + const terms = highlight.toLowerCase().split(/\s+/).filter(x => x); + if (terms.length === 0) return; // nothing to do + + // There should never be more than one element matching "div.body" + const divBody = document.querySelectorAll("div.body"); + const body = divBody.length ? divBody[0] : document.querySelector("body"); + window.setTimeout(() => { + terms.forEach((term) => _highlightText(body, term, "highlighted")); + }, 10); + + const searchBox = document.getElementById("searchbox"); + if (searchBox === null) return; + searchBox.appendChild( + document + .createRange() + .createContextualFragment( + '

' + + '' + + _("Hide Search Matches") + + "

" + ) + ); + }, + + /** + * helper function to hide the search marks again + */ + hideSearchWords: () => { + document + .querySelectorAll("#searchbox .highlight-link") + .forEach((el) => el.remove()); + document + .querySelectorAll("span.highlighted") + .forEach((el) => el.classList.remove("highlighted")); + localStorage.removeItem("sphinx_highlight_terms") + }, + + initEscapeListener: () => { + // only install a listener if it is really needed + if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) return; + + document.addEventListener("keydown", (event) => { + // bail for input elements + if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return; + // bail with special keys + if (event.shiftKey || event.altKey || event.ctrlKey || event.metaKey) return; + if (DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS && (event.key === "Escape")) { + SphinxHighlight.hideSearchWords(); + event.preventDefault(); + } + }); + }, +}; + +_ready(() => { + /* Do not call highlightSearchWords() when we are on the search page. + * It will highlight words from the *previous* search query. + */ + if (typeof Search === "undefined") SphinxHighlight.highlightSearchWords(); + SphinxHighlight.initEscapeListener(); +}); diff --git a/docs/build/html/genindex.html b/docs/build/html/genindex.html new file mode 100644 index 0000000..548b525 --- /dev/null +++ b/docs/build/html/genindex.html @@ -0,0 +1,226 @@ + + + + + + + Index — whisper_live documentation + + + + + + + + + + + + + + + + +
+
+
+ + +
+ + +

Index

+ +
+ A + | C + | D + | F + | G + | M + | R + | S + | T + | U + | W + +
+

A

+ + +
+ +

C

+ + +
+ +

D

+ + +
+ +

F

+ + +
+ +

G

+ + +
+ +

M

+ + +
+ +

R

+ + + +
+ +

S

+ + + +
+ +

T

+ + +
+ +

U

+ + +
+ +

W

+ + + +
    +
  • + whisper_live.client + +
    • +
    +
  • + whisper_live.server + +
    • +
+ + + +
+ +
+
+ +
+
+
+ ©2023, Collabora. + + | + Powered by Sphinx 7.2.6 + & Alabaster 0.7.13 + +
+ + + + + + \ No newline at end of file diff --git a/docs/build/html/index.html b/docs/build/html/index.html new file mode 100644 index 0000000..cd207e0 --- /dev/null +++ b/docs/build/html/index.html @@ -0,0 +1,295 @@ + + + + + + + + Welcome to whisper_live’s documentation! — whisper_live documentation + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

Welcome to whisper_live’s documentation!

+
+
+
+
+class whisper_live.server.ServeClient(websocket, task='transcribe', device=None, multilingual=False, language=None, client_uid=None)
+
+
Attributes:

RATE (int): The audio sampling rate (constant) set to 16000. +SERVER_READY (str): A constant message indicating that the server is ready. +DISCONNECT (str): A constant message indicating that the client should disconnect. +client_uid (str): A unique identifier for the client. +data (bytes): Accumulated audio data. +frames (bytes): Accumulated audio frames. +language (str): The language for transcription. +task (str): The task type, e.g., “transcribe.” +transcriber (WhisperModel): The Whisper model for speech-to-text. +timestamp_offset (float): The offset in audio timestamps. +frames_np (numpy.ndarray): NumPy array to store audio frames. +frames_offset (float): The offset in audio frames. +text (list): List of transcribed text segments. +current_out (str): The current incomplete transcription. +prev_out (str): The previous incomplete transcription. +t_start (float): Timestamp for the start of transcription. +exit (bool): A flag to exit the transcription thread. +same_output_threshold (int): Threshold for consecutive same output segments. +show_prev_out_thresh (int): Threshold for showing previous output segments. +add_pause_thresh (int): Threshold for adding a pause (blank) segment. +transcript (list): List of transcribed segments. +send_last_n_segments (int): Number of last segments to send to the client. +wrapper (textwrap.TextWrapper): Text wrapper for formatting text. +pick_previous_segments (int): Number of previous segments to include in the output. +websocket: The WebSocket connection for the client.

+
+
+
+
+add_frames(frame_np)
+

Add audio frames to the ongoing audio stream buffer.

+

This method is responsible for maintaining the audio stream buffer, allowing the continuous addition +of audio frames as they are received. It also ensures that the buffer does not exceed a specified size +to prevent excessive memory usage.

+

If the buffer size exceeds a threshold (45 seconds of audio data), it discards the oldest 30 seconds +of audio data to maintain a reasonable buffer size. If the buffer is empty, it initializes it with the provided +audio frame. The audio stream buffer is used for real-time processing of audio data for transcription.

+
+
Args:

frame_np (numpy.ndarray): The audio frame data as a NumPy array.

+
+
+
+ +
+
+cleanup()
+

Perform cleanup tasks before exiting the transcription service.

+

This method performs necessary cleanup tasks, including stopping the transcription thread, marking +the exit flag to indicate the transcription thread should exit gracefully, and destroying resources +associated with the transcription process.

+
+ +
+
+disconnect()
+

Notify the client of disconnection and send a disconnect message.

+

This method sends a disconnect message to the client via the WebSocket connection to notify them +that the transcription service is disconnecting gracefully.

+
+ +
+
+fill_output(output)
+

Format the current incomplete transcription output by combining it with previous complete segments. +The resulting transcription is wrapped into two lines, each containing a maximum of 50 characters.

+

It ensures that the combined transcription fits within two lines, with a maximum of 50 characters per line. +Segments are concatenated in the order they exist in the list of previous segments, with the most +recent complete segment first and older segments prepended as needed to maintain the character limit. +If a 3-second pause is detected in the previous segments, any text preceding it is discarded to ensure +the transcription starts with the most recent complete content. The resulting transcription is returned +as a single string.

+
+
Args:

output(str): The current incomplete transcription segment.

+
+
Returns:

str: A formatted transcription wrapped in two lines.

+
+
+
+ +
+
+speech_to_text()
+

Process an audio stream in an infinite loop, continuously transcribing the speech.

+

This method continuously receives audio frames, performs real-time transcription, and sends +transcribed segments to the client via a WebSocket connection.

+

If the client’s language is not detected, it waits for 30 seconds of audio input to make a language prediction. +It utilizes the Whisper ASR model to transcribe the audio, continuously processing and streaming results. Segments +are sent to the client in real-time, and a history of segments is maintained to provide context.Pauses in speech +(no output from Whisper) are handled by showing the previous output for a set duration. A blank segment is added if +there is no speech for a specified duration to indicate a pause.

+
+
Raises:

Exception: If there is an issue with audio processing or WebSocket communication.

+
+
+
+ +
+
+update_segments(segments, duration)
+

Processes the segments from whisper. Appends all the segments to the list +except for the last segment assuming that it is incomplete.

+

Updates the ongoing transcript with transcribed segments, including their start and end times. +Complete segments are appended to the transcript in chronological order. Incomplete segments +(assumed to be the last one) are processed to identify repeated content. If the same incomplete +segment is seen multiple times, it updates the offset and appends the segment to the transcript. +A threshold is used to detect repeated content and ensure it is only included once in the transcript. +The timestamp offset is updated based on the duration of processed segments. The method returns the +last processed segment, allowing it to be sent to the client for real-time updates.

+
+
Args:

segments(dict) : dictionary of segments as returned by whisper +duration(float): duration of the current chunk

+
+
Returns:
+
dict or None: The last processed segment with its start time, end time, and transcribed text.

Returns None if there are no valid segments to process.

+
+
+
+
+
+ +
+ +
+
+class whisper_live.server.TranscriptionServer
+

Represents a transcription server that handles incoming audio from clients.

+
+
Attributes:

RATE (int): The audio sampling rate (constant) set to 16000. +vad_model (torch.Module): The voice activity detection model. +vad_threshold (float): The voice activity detection threshold. +clients (dict): A dictionary to store connected clients. +websockets (dict): A dictionary to store WebSocket connections. +clients_start_time (dict): A dictionary to track client start times. +max_clients (int): Maximum allowed connected clients. +max_connection_time (int): Maximum allowed connection time in seconds.

+
+
+
+
+get_wait_time()
+

Calculate and return the estimated wait time for clients.

+
+
Returns:

float: The estimated wait time in minutes.

+
+
+
+ +
+
+recv_audio(websocket)
+

Receive audio chunks from a client in an infinite loop.

+

Continuously receives audio frames from a connected client +over a WebSocket connection. It processes the audio frames using a +voice activity detection (VAD) model to determine if they contain speech +or not. If the audio frame contains speech, it is added to the client’s +audio data for ASR. +If the maximum number of clients is reached, the method sends a +“WAIT” status to the client, indicating that they should wait +until a slot is available. +If a client’s connection exceeds the maximum allowed time, it will +be disconnected, and the client’s resources will be cleaned up.

+
+
Args:

websocket (WebSocket): The WebSocket connection for the client.

+
+
Raises:

Exception: If there is an error during the audio frame processing.

+
+
+
+ +
+
+run(host, port=9090)
+

Run the transcription server.

+
+
Args:

host (str): The host address to bind the server. +port (int): The port number to bind the server.

+
+
+
+ +
+ +
+
+

Indices and tables

+ +
+ + +
+ +
+
+ +
+
+
+ ©2023, Collabora. + + | + Powered by Sphinx 7.2.6 + & Alabaster 0.7.13 + + | + Page source +
+ + + + + + \ No newline at end of file diff --git a/docs/build/html/objects.inv b/docs/build/html/objects.inv new file mode 100644 index 0000000..00b0d2b --- /dev/null +++ b/docs/build/html/objects.inv @@ -0,0 +1,7 @@ +# Sphinx inventory version 2 +# Project: whisper_live +# Version: +# The remainder of this file is compressed using zlib. +xڭn w?U5kN*ErF€㭯%uL7*8L + 7l[+Hp >Rw8< +C 9Nʥd[S)B7ѭAH5Ftq&%A4 -C8"E'9 Pi ree_!\!C ZDxބO!V7ФܐStґqZ|ˤhx-l=Z2#u񱩻"}+Pp.=b i{\s,{/B{ \ No newline at end of file diff --git a/docs/build/html/py-modindex.html b/docs/build/html/py-modindex.html new file mode 100644 index 0000000..17f51ed --- /dev/null +++ b/docs/build/html/py-modindex.html @@ -0,0 +1,123 @@ + + + + + + + Python Module Index — whisper_live documentation + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ + +

Python Module Index

+ +
+ w +
+ + + + + + + + + + + + + +
 
+ w
+ whisper_live +
    + whisper_live.client +
    + whisper_live.server +
+ + +
+ +
+
+ +
+
+
+ ©2023, Collabora. + + | + Powered by Sphinx 7.2.6 + & Alabaster 0.7.13 + +
+ + + + + + \ No newline at end of file diff --git a/docs/build/html/search.html b/docs/build/html/search.html new file mode 100644 index 0000000..0ae5276 --- /dev/null +++ b/docs/build/html/search.html @@ -0,0 +1,117 @@ + + + + + + + Search — whisper_live documentation + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +

Search

+ + + + +

+ Searching for multiple words only shows matches that contain + all words. +

+ + +
+ + + +
+ + + +
+ +
+ + +
+ +
+
+ +
+
+
+ ©2023, Collabora. + + | + Powered by Sphinx 7.2.6 + & Alabaster 0.7.13 + +
+ + + + + + \ No newline at end of file diff --git a/docs/build/html/searchindex.js b/docs/build/html/searchindex.js new file mode 100644 index 0000000..bc25beb --- /dev/null +++ b/docs/build/html/searchindex.js @@ -0,0 +1 @@ +Search.setIndex({"docnames": ["index"], "filenames": ["index.rst"], "titles": ["Welcome to whisper_live\u2019s documentation!"], "terms": {"class": 0, "server": 0, "servecli": 0, "websocket": 0, "task": 0, "transcrib": 0, "devic": 0, "none": 0, "multilingu": 0, "fals": 0, "languag": 0, "client_uid": 0, "attribut": 0, "rate": 0, "int": 0, "The": 0, "audio": 0, "sampl": 0, "constant": 0, "set": 0, "16000": 0, "server_readi": 0, "str": 0, "A": 0, "messag": 0, "i": 0, "readi": 0, "disconnect": 0, "client": 0, "should": 0, "uniqu": 0, "identifi": 0, "data": 0, "byte": 0, "accumul": 0, "frame": 0, "transcript": 0, "type": 0, "e": 0, "g": 0, "whispermodel": 0, "whisper": 0, "model": 0, "speech": 0, "text": 0, "timestamp_offset": 0, "float": 0, "offset": 0, "timestamp": 0, "frames_np": 0, "numpi": 0, "ndarrai": 0, "arrai": 0, "store": 0, "frames_offset": 0, "list": 0, "segment": 0, "current_out": 0, "current": 0, "incomplet": 0, "prev_out": 0, "previou": 0, "t_start": 0, "start": 0, "exit": 0, "bool": 0, "flag": 0, "thread": 0, "same_output_threshold": 0, "threshold": 0, "consecut": 0, "same": 0, "output": 0, "show_prev_out_thresh": 0, "show": 0, "add_pause_thresh": 0, "ad": 0, "paus": 0, "blank": 0, "send_last_n_seg": 0, "number": 0, "last": 0, "send": 0, "wrapper": 0, "textwrap": 0, "textwrapp": 0, "format": 0, "pick_previous_seg": 0, "includ": 0, "connect": 0, "add_fram": 0, "frame_np": 0, "add": 0, "ongo": 0, "stream": 0, "buffer": 0, "thi": 0, "method": 0, "respons": 0, "maintain": 0, "allow": 0, "continu": 0, "addit": 0, "thei": 0, "ar": 0, "receiv": 0, "It": 0, "also": 0, "ensur": 0, "doe": 0, "exce": 0, "specifi": 0, "size": 0, "prevent": 0, "excess": 0, "memori": 0, "usag": 0, "If": 0, "45": 0, "second": 0, "discard": 0, "oldest": 0, "30": 0, "reason": 0, "empti": 0, "initi": 0, "provid": 0, "us": 0, "real": 0, "time": 0, "process": 0, "arg": 0, "cleanup": 0, "perform": 0, "befor": 0, "servic": 0, "necessari": 0, "stop": 0, "mark": 0, "gracefulli": 0, "destroi": 0, "resourc": 0, "associ": 0, "notifi": 0, "via": 0, "them": 0, "fill_output": 0, "combin": 0, "complet": 0, "result": 0, "wrap": 0, "two": 0, "line": 0, "each": 0, "contain": 0, "maximum": 0, "50": 0, "charact": 0, "fit": 0, "within": 0, "per": 0, "concaten": 0, "order": 0, "exist": 0, "most": 0, "recent": 0, "first": 0, "older": 0, "prepend": 0, "need": 0, "limit": 0, "3": 0, "detect": 0, "ani": 0, "preced": 0, "content": 0, "return": 0, "singl": 0, "string": 0, "speech_to_text": 0, "an": 0, "infinit": 0, "loop": 0, "wait": 0, "input": 0, "make": 0, "predict": 0, "util": 0, "asr": 0, "sent": 0, "histori": 0, "context": 0, "from": 0, "handl": 0, "durat": 0, "rais": 0, "except": 0, "issu": 0, "commun": 0, "update_seg": 0, "append": 0, "all": 0, "assum": 0, "updat": 0, "end": 0, "chronolog": 0, "one": 0, "repeat": 0, "seen": 0, "multipl": 0, "onli": 0, "onc": 0, "base": 0, "dict": 0, "dictionari": 0, "chunk": 0, "its": 0, "valid": 0, "transcriptionserv": 0, "repres": 0, "incom": 0, "vad_model": 0, "torch": 0, "modul": 0, "voic": 0, "activ": 0, "vad_threshold": 0, "clients_start_tim": 0, "track": 0, "max_client": 0, "max_connection_tim": 0, "get_wait_tim": 0, "calcul": 0, "estim": 0, "minut": 0, "recv_audio": 0, "over": 0, "vad": 0, "determin": 0, "reach": 0, "statu": 0, "until": 0, "slot": 0, "avail": 0, "clean": 0, "up": 0, "error": 0, "dure": 0, "run": 0, "host": 0, "port": 0, "9090": 0, "address": 0, "bind": 0, "index": 0, "search": 0, "page": 0}, "objects": {"whisper_live": [[0, 0, 0, "-", "client"], [0, 0, 0, "-", "server"]], "whisper_live.server": [[0, 1, 1, "", "ServeClient"], [0, 1, 1, "", "TranscriptionServer"]], "whisper_live.server.ServeClient": [[0, 2, 1, "", "add_frames"], [0, 2, 1, "", "cleanup"], [0, 2, 1, "", "disconnect"], [0, 2, 1, "", "fill_output"], [0, 2, 1, "", "speech_to_text"], [0, 2, 1, "", "update_segments"]], "whisper_live.server.TranscriptionServer": [[0, 2, 1, "", "get_wait_time"], [0, 2, 1, "", "recv_audio"], [0, 2, 1, "", "run"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"]}, "titleterms": {"welcom": 0, "whisper_l": 0, "": 0, "document": 0, "indic": 0, "tabl": 0}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx": 60}, "alltitles": {"Welcome to whisper_live\u2019s documentation!": [[0, "welcome-to-whisper-live-s-documentation"]], "Indices and tables": [[0, "indices-and-tables"]]}, "indexentries": {"serveclient (class in whisper_live.server)": [[0, "whisper_live.server.ServeClient"]], "transcriptionserver (class in whisper_live.server)": [[0, "whisper_live.server.TranscriptionServer"]], "add_frames() (whisper_live.server.serveclient method)": [[0, "whisper_live.server.ServeClient.add_frames"]], "cleanup() (whisper_live.server.serveclient method)": [[0, "whisper_live.server.ServeClient.cleanup"]], "disconnect() (whisper_live.server.serveclient method)": [[0, "whisper_live.server.ServeClient.disconnect"]], "fill_output() (whisper_live.server.serveclient method)": [[0, "whisper_live.server.ServeClient.fill_output"]], "get_wait_time() (whisper_live.server.transcriptionserver method)": [[0, "whisper_live.server.TranscriptionServer.get_wait_time"]], "module": [[0, "module-whisper_live.client"], [0, "module-whisper_live.server"]], "recv_audio() (whisper_live.server.transcriptionserver method)": [[0, "whisper_live.server.TranscriptionServer.recv_audio"]], "run() (whisper_live.server.transcriptionserver method)": [[0, "whisper_live.server.TranscriptionServer.run"]], "speech_to_text() (whisper_live.server.serveclient method)": [[0, "whisper_live.server.ServeClient.speech_to_text"]], "update_segments() (whisper_live.server.serveclient method)": [[0, "whisper_live.server.ServeClient.update_segments"]], "whisper_live.client": [[0, "module-whisper_live.client"]], "whisper_live.server": [[0, "module-whisper_live.server"]]}}) \ No newline at end of file diff --git a/docs/make.bat b/docs/make.bat new file mode 100644 index 0000000..747ffb7 --- /dev/null +++ b/docs/make.bat @@ -0,0 +1,35 @@ +@ECHO OFF + +pushd %~dp0 + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set SOURCEDIR=source +set BUILDDIR=build + +%SPHINXBUILD% >NUL 2>NUL +if errorlevel 9009 ( + echo. + echo.The 'sphinx-build' command was not found. Make sure you have Sphinx + echo.installed, then set the SPHINXBUILD environment variable to point + echo.to the full path of the 'sphinx-build' executable. Alternatively you + echo.may add the Sphinx directory to PATH. + echo. + echo.If you don't have Sphinx installed, grab it from + echo.https://www.sphinx-doc.org/ + exit /b 1 +) + +if "%1" == "" goto help + +%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% +goto end + +:help +%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% + +:end +popd diff --git a/docs/source/conf.py b/docs/source/conf.py new file mode 100644 index 0000000..f944f34 --- /dev/null +++ b/docs/source/conf.py @@ -0,0 +1,36 @@ +# Configuration file for the Sphinx documentation builder. +# +# For the full list of built-in configuration values, see the documentation: +# https://www.sphinx-doc.org/en/master/usage/configuration.html + +# -- Project information ----------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information +import os +import sys +sys.path.insert(0, os.path.abspath('../..')) + +project = 'whisper_live' +copyright = '2023, Collabora' +author = 'Collabora' + +# -- General configuration --------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration + +extensions = [] + +templates_path = ['_templates'] +exclude_patterns = [] + + + +# -- Options for HTML output ------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output + +html_theme = 'alabaster' +html_static_path = ['_static'] + +extensions = [ + 'sphinx.ext.duration', + 'sphinx.ext.doctest', + 'sphinx.ext.autodoc', +] diff --git a/docs/source/index.rst b/docs/source/index.rst new file mode 100644 index 0000000..e57b0ad --- /dev/null +++ b/docs/source/index.rst @@ -0,0 +1,25 @@ +.. whisper_live documentation master file, created by + sphinx-quickstart on Fri Sep 22 11:39:30 2023. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to whisper_live's documentation! +======================================== + +.. toctree:: + :maxdepth: 2 + + +.. automodule:: whisper_live.server + :members: + +.. automodule:: whisper_live.client + + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search`