From f5161bd781e2593cbcb3fc3ffdb8420f86340257 Mon Sep 17 00:00:00 2001 From: rajashekar Date: Sun, 18 Aug 2024 08:57:23 +0000 Subject: [PATCH] deploy: e9b74fb019b661c11fccdc9e9f2aff930600fadd --- .buildinfo | 4 + .doctrees/environment.pickle | Bin 0 -> 18540 bytes .doctrees/index.doctree | Bin 0 -> 27959 bytes .doctrees/modules.doctree | Bin 0 -> 2729 bytes .nojekyll | 0 _sources/index.rst.txt | 23 + _sources/modules.rst.txt | 5 + _static/alabaster.css | 708 +++++++++++++++++++++++ _static/basic.css | 925 +++++++++++++++++++++++++++++++ _static/custom.css | 1 + _static/doctools.js | 156 ++++++ _static/documentation_options.js | 13 + _static/file.png | Bin 0 -> 286 bytes _static/language_data.js | 199 +++++++ _static/minus.png | Bin 0 -> 90 bytes _static/plus.png | Bin 0 -> 90 bytes _static/pygments.css | 84 +++ _static/searchtools.js | 620 +++++++++++++++++++++ _static/sphinx_highlight.js | 154 +++++ genindex.html | 103 ++++ index.html | 280 ++++++++++ modules.html | 110 ++++ objects.inv | 6 + search.html | 120 ++++ searchindex.js | 1 + 25 files changed, 3512 insertions(+) create mode 100644 .buildinfo create mode 100644 .doctrees/environment.pickle create mode 100644 .doctrees/index.doctree create mode 100644 .doctrees/modules.doctree create mode 100644 .nojekyll create mode 100644 _sources/index.rst.txt create mode 100644 _sources/modules.rst.txt create mode 100644 _static/alabaster.css create mode 100644 _static/basic.css create mode 100644 _static/custom.css create mode 100644 _static/doctools.js create mode 100644 _static/documentation_options.js create mode 100644 _static/file.png create mode 100644 _static/language_data.js create mode 100644 _static/minus.png create mode 100644 _static/plus.png create mode 100644 _static/pygments.css create mode 100644 _static/searchtools.js create mode 100644 _static/sphinx_highlight.js create mode 100644 genindex.html create mode 100644 index.html create mode 100644 modules.html create mode 100644 objects.inv create mode 100644 search.html create mode 100644 searchindex.js diff --git a/.buildinfo b/.buildinfo new file mode 100644 index 0000000..713061f --- /dev/null +++ b/.buildinfo @@ -0,0 +1,4 @@ +# Sphinx build info version 1 +# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. +config: 0850e4661be068dd7a7079ad17de45df +tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/.doctrees/environment.pickle b/.doctrees/environment.pickle new file mode 100644 index 0000000000000000000000000000000000000000..c03c8e1149e87fce9fac11c99240ce645d6f7cc6 GIT binary patch literal 18540 zcmcIs3!Gg?Sx@%;&Svv&)Al9-nzZb0+R{=A)uc_DhE291X=tHMPtU#g?9MrR?>RT; zkz`v_>CYb}i=(affP#whP(e|AqKL{v5al6?itpzSR8Zt)K}5v=_s!#+yW3ED%jTEg zJu~0Td^7XSH{X1ZnSDj?Yuww{@IN_`w1gj?oASalejJ5OFHCbeeoN*z>IX}p$MZc8 z=jZd?vfFL7@>w}lk7{Y`d38U|reNL77&gI~g?jp(4{5TpVagBNtgS*9$7#1U9 zRE(iP52__p9A$CM({*c6IOosja#WAZSn2kK!@#anl&nQEW~{5R@|^&nRm0;JyS`d2&7oA+c>qTwHW*J0!y^> z+P&9a_uR_2Za7#p5Rh5AL_R2v{Idjbv z1KtWkX0hiOf;e-2!wX$n$ITDMQIwvadeD@ee-KnWpUcX;m!?QMZle*Mb>^}M9$0kJ z*bS40n=*-)pYR;-nm*Mt9!(ez@!#-+z(d*yRNzl3prBv=G?52I&swS zXy$IcjH1if%h0Cj%z>t1lzL9=&3Wjv=7D=$u=bK1;f9K9h(=?r#d+GX;IDL%$2=jx z9t~munK_=<6G9%)UiCx#c;P$-Gb`6&1j509s@P80k+fJ0@=k;7;5Q!PtQl~lAg}M$GkO4S;y66 z=stY_liXM?(mOU`f(;t6!VdE9)5S*D+0h&Zk4HKMNPa z=qv^@%wEL?fIs-IRwj1GazurZM~ z8%_;k(t^||ji9sOQAP;KqZzVWkBuNW?k-4MA;A%WgBM)FO|T0c>?UjxkZU7@z+MXE zob~I(-D~uCd23@M5fl3%@f<`64-u^3D2WY8$w=y6Qj2{SIYbNv#HoxOUCmOQfdH=O znrCC5c$z3w$d7V9C{cTyA*8GLHQSNu9D*ixEo_s*i{Uw0s}9MEgM?30g)_mjS6#3q zWRj|i;{?-=Lbm}NM17QOU?fVa5jp)D?4dQ z)$mijCQBMd%7LTRCWC|5RKW;2aBo)a`P?OtIeT&PrZ{HxC~3vPNMYi+aZQjCq536` zG%aQ|tc+z=x95HfZRLX8s=B3vQsD%aCW(0rNl%H(SbGIbEgo?c9sZ!6qDhpct&EOi zqnq`zZiem6_;LK;XvJ9xfl7o_i=l)$NlUF~$gZi1!Kg=LWE1#At&@hASWR_dMqk6B z0yf`k2ukW?U2iN+YBdKiwMWMjs&3bV1hvQkHK%pmeb-HU$@SBq=47+k zn5@xAP#Js8AS=yu%)qo5Alck??{4VM_wLEPqDkFPAdweYc6Z%-50#%nxowW+qq9dJ zSs3wkP!J5r=#+ZRhz|^ilyN>DblvZ1$l{u7W*!BV?bHZZZXBs zMpLV}lBT}xwv$JWRA%=dJy?0s!K3>RAKAD6z=7ijPn`HJ?Bt@AvK^p9xlQoRk^QrW zPVPU1CP$9!Yxq-9Jdf(bq;Z`y;;auxS;j(6fwfE;S2-A6SY8$YP(LnJK-zOE)r8iH zE#JtRA*Q@d0n@0}@XmM*(oKjs5UQZ;Mpd{{swj9#rgw!Ac6SL(f(Z%(E1n7r6N1%G z+Hac`s3gejX|!Gyu~wrsRpO9=Y7{L12&RIe(um?XI-7tUbe}Be%SW%Kg@Q9HgBIho zcW~ljcNB`-r3KI&jnEo1HC85|ZNwG|HX_UhKL(*#@{SelN!ccqZ(9M1z0(;fpu%%m zufXKjmrIrA4<)b!P5q_^S(MLQUWStSOPa|{ZyD-_HJo}RjNL)9j!&UZbFA-a2B41ghHO-}F?+pmG6M%}EsAw3WB$ms*Faw{inZ1|UO*PA z+D;sH@C*Bf4-16-7-y#7P)83yXAfQONC}X(`oY-E@}3(^Ws57Cw0s zb6M(wOklEcb=~#0t|@@ysXz>3lJ!jc1HK=kBQ^kAHKfWg8QYapRu~yhV$P_3P+Cvp z!~xOS&BKluXjmGiZIRv(n)?}?^ks1Q=u!q=o8>l8D&H;kz?0bxA8h_eF0K++2f^Ak zYmj^{+;%-QUV=}F$)Ks=(_*iwa*epwB(E!=&zm*C9b%_R?h?;3$?L@pCi(m&*{?Mh z>gC2IQ}6d34iz)@i_-XV^eHZKv!O@%vc)swdQOT}HL=G_+fGVyZL<{pdlUYj~) z$9A7^OzYjVVlPN_zi|0mwY6(Y45$l_zjI=qzryzB&#W~_0;a~9RXx>uum5*b(-0$t#3p~WWQfX{{DdY zLHcU%Me3*UQlSNbl68u3~K{1Ne^IvLDi*97zUVN^dRe%#dgiJ5Mbe1j#~PZqrO zQ-)6BjWcUZ%{PfRmnKs3bujjy)&u<+{ry?-R))V#{G8#lpBHa8$zKq^sFTLK!9X1lv=ID| z?fegH>JM$358Kp7Z0e)pW2W&RiI1D)AKUUj5uY%?KeZ_TO#Hb4ep2k^?eQ13#a|Y~ z`77~eQ}3_sM*JH)ufG+4XNvz`{DVpUqxdJ2{FL~#N&cJZ+?vkUT0_{>`HZO}K6@cJ ztB!?#x2gYFGO*8CzWz_~dBehA5MMOqUlL!|Njajex)6FHcxj+jhmRe4D_jxS;p>L&JAq68M^*m% z1&=zys+NVy@MlVf(S9FT&2 z%T0!<(uip?O1UwUTSvKZlUq-@36tAExs4{b35l7tjBqn0FX!YIO7?PcE0R3JU>j1w zCHP_Zb|m(2>N2FP-Num10a0zPFey1mc9(J|!YsgA*+8otZIdss8pPG^%v!xBK?Nw7 zroj%Ak{c2@5TJiT8G%l${g-yrv#rEd+;aY~ed3_FI@s5>W{te!j?g2!)vJ`;!j)*Q zVq&9m^r)ZIyatXASj`E7y38xVPK+klg&&^svncm$lY0&liU3yM|N$IH)U>a$&ae}>6a80T7+H&c2RPek~>GhPpp#*q7rEe?&_9JaXL~sig z+*&FhV zO@q72nY)o$GSyyIDv>3VDS>OJ|4(T~ylPZbk0Hrxdg8NGuxlY?Mwy_w~M^E6E>IGF~f*Sp(V>zf( z+A9EAR+Xd5jSJ@=0+jG~t%ZTkj$I8=UJP=1_rYa}fObAB5Ej$7H>_CbKc+8FnEM-I zgV+K?0rOO-{$%W5cpi z^6KX^U2@YhxN=wIGd(N%r@I(vuzXlaS|@Oy!jsQ@S0*=VHw1Y0$Ec>r{w2%!oRkFj4L{xW@qKz6|^0vSRvOt^zwbt9*TOnNwrJ;cD_n4`-Q zusuNECAq1FS__C7!zbv#ZAVua;B&hmM_RbxK-|yH4hl%As0qNylp+Cn@^P(cjB1uV zhwu-?bG1_2=a{w#1-gh6*5LJ>^1XD95rBoJX|EC{YS)Ho%n#cFSmH`Kh6XH?oO2Yr zC!&#GHOZ>&(DlaKns|*liXAPW>X2}8!-WF_-T$uoL+%%^=;OWd z>i#QFb1tLXHx%PQq>k>*$YDeT8p>NtIemi#A&?Ze$<#FfFae6XX`4KrzY=%ExC7ec z<5N@9_<#K1{sTu3@_v0RkpueXPdyJlOxyBf_-Si3Qf`%_#VEpQ_~17)C8{0!9z@I^eIMvCq+U*tY_clHQ@I3Drr>F^8cS- z@w%klsN4Yx(hWb^r|u=?!M_4YQg!7}$rDWytlMWdGhE5~t`^+Wy-L6$HGumCMTT6a z95OnEiz@x83$HY;SOlL2>a41y!=$7jE-n^>A@eUA=_R(M!DE#G|nWF0KN$#6=qGKCGm;ST&~M z(^`K;;ayLg!nD1VqZP8F4+G0$Uu{S*5C^n)>BU~X6g$v^>g#f%cGZ3QtGV5x*vcq^ z34ESxNrFpJ0QOT`wxE?}G|hI*Aul4F-#%Zd8L)cL54DA_{GEbR-f9_-(7i$}cuYJr zIE+qkl?h=1dp)PW=Bmpva`0BV!vGcNCIoHf8&MTPyHEIaNJgZf9P{->3m8!GB#3O> z%NbHU9fb`FtPMdx6ocZd=_R-WLja58Q1J4ZA+bq5f12**POF=_(-fGT*0REWNsdn| zi31q!V=7IEx8w^5Unh&Wo(Rq;)FOIMgZi44Hd_=Mcoe}Fe4dOCb_bVTq$JpRu>#&f zH)vAa1Pc{$;#yjP(dVn~68q@nWx0JkL zmmc1v9^E8HH_4-$jOHfo=q71&lQgG%0id84_$YFXP0dE+aePyBY ziB%)@s1hos(-j2&c&F4V2>#JdQLH+_2M(Td>6%2lBza=hh&{N=GaarV^p`rNQbFj? zcZy=w3EjQ_Si9`l+Ot}xWX~?Q^(2C06FPi`XWm4oC{~@kJqO6-EDMYmt{Q!Ncd>oD zf`4!9lsX0fUf(H-RVVP!!82|nTPc_CTQxEd@A8T+R}lN2PAOFo`|eIrtU9s#_v0>R zgiCm3hJJX}C_S)C-DbcW8|6JHOxA}wrBOlV2RlWv>SVr@3{d?nqjD>JPh{c%#?hHF z>EE(yq~E>^E@3lTtR(M=W6c&KGqSUd%-9*n4DeK$L~& z&ff2gqDv9Rr}D5~fxe!hj=P;vT-2`<+ziTUm)m#BtIDy{L%@qzz>NAF#b>4`n8jx{ zIELS);3fQfoPST?7uWReYyvFv8x(Qj&jB@y6W^E?Ns7~qq0^&jp!s{&MZ>G439M>LoT=r+D zbP-I!lChJU5mM}DoSokkC694YpZ>tZc~u4BIu6@WxQ)EssKS9Y4!5m0&h0iR{`Let z^k#E|0#a*hK(<>B^Bv`6v00^u4l6?HQ;sR>JE7{>_zkTtVz!BoE2-i9{wm(+!iR72 zw|Mv)2FUmFwGJc@j6~=QFKH+U4_`n0;_OeIWnRPMH9tA-mFwWWwPV6_PIZxQk`w(l zwm}UVqP64VM!79T$D8F=pp@gzlG6QKF`>#QvwsF|ArD5fT8p&`6{ zqb5fYXM$w18_y0ei0`03t}$l* ze!wx1tx2!NM+{_tj6nWuaE_ZU@-OY!+28@Bm*ikUgi{FXGhJ>iBApQC6zSZ7sKQ&pTQN$y*N?xmLaz#Yp;+L4=Bx7Rs}Q4wY*T14h{Z{p zL+tfk=mv6}n+NYkMvffizj9G2Bj{6)TJzw8JgO&YHGF~}0#}aV8iww*t*hX}YCao| z@jIHzvQ7}9r5#X^g6FS^fSYFTLF?eXi~>0tg&qoWgju71B#Up9E?-dH|38>1GMFNEEr{1fHqm z)-0ZxsGBDg{RD#z5}P|(Qb9uD&n=K;LxFjeZiI-X=hFJIlnqGBE$s!=J4qOtf!x$y z*2MiY2rVkPw7rDU;gypu-`ZYIS2Kz(mo;YgD4h_v`Or32$RhPF3H`1tGK0;kQ~wY1 Cp8&4_ literal 0 HcmV?d00001 diff --git a/.doctrees/index.doctree b/.doctrees/index.doctree new file mode 100644 index 0000000000000000000000000000000000000000..3a1d82e19822239209eb72d32c5590f759ef7fa0 GIT binary patch literal 27959 zcmeHQdyFK?MwMxijHdZe#4Tv-o_O?U}Bf z?%AI1aXwC5Q3MhQP(;9gL?DP_0YL%&Kvn=D{^0jj zb#>Rw&dy`cNqiTt<+<+adVgPi-><%^`s$;@ug=u>i9dccY}k&sSuicj^DP!O`IzNb z;yUx9=BJy}A8WqUoZ{nwxe@wtP+?8J4>2mX<5~gpnm6$A2*r;aH!LI>j8^=5OL}{l z|CQr~kr^>VWo|}}?-_M7j96f-Ixd?rDgi?b%P4Q4L~Wt6hSKmPxI{Qtm>W^6xf7ZH6%Mz^Qz>BUjem@#5= zKlUuG%Ca@~KJ=^P-<{ufE66^@hef}ExS)UF2$C-G(YkNNE?$13Y4SskS8-#D(a0sb z+E1H&tZr^vtP$DG#Ubzoh9dPaAHRe#g^a=l5TWY&<>odYu^r2T{MhD)lZ?`UF)yx{ zS-`C3;y#`eqzHY_-9p?P#86fv@v2I(m#Kd)+owgp5DQ&w?@WF)>5BYDU^W^oXqxT) z`$TL1f*vfT2cO)KOpuTKe8L3zFt4~&$TQ@aP>nyB#O}&6rcT^5D14}mxbKnzIOEP) z6~G@!>abv76j@G%|4H=#1 zo__M;<*QGMK?xSVL$L5T!~h9!I3`nPLR`oA@wNNlb;KG7oM^PhOC>EW1wGi44 zbFHx8_{GLn!zr#SsZa>lt2qOI3(zK27G=pOUZJrS*}hlsgQ`rI^sOAzyA2dR6bDX| zPxoDcCeJ}jS&juYM^cpUf1+tOL*m>|g7`lU?)_K~DZoe2Q=-_1RIyzfKzV;0c_+P} zWurSUC)!>rl5*rlsEI~o$6=kC06C$scEKC)%Kg0MA7 z#6SCN2-GMf>=g`PKuzX?+5NzD0TW#p>fMY?V`_eO?!xqpvB4me{dEXn!!(`}vc&-8 zS%VZq9srw>xyC|~T`HIj2yN4VT7tGSASH|{pk@e+ioBgrVlRTsW+m{$Pzw4mfua*{ z;RIayvfB_i+ZNVF14Ai{k2Qo`i{FsTL2PAiCk!^Dw zJXon9DIpPxnQ`0{v6<%^K7s=PTNG3mYG7Ivl1zilawu>F_)|s{tS;CXHS{+^BNllB z9x^v&Vc_Gi;jb|-ZQG0}y@i*NWm+3FOy_Ls1gdQrN`uA|HAHdya{2AP*85t_FTM@E zosE(=`X41~=uW87(gLDSG}K7V$05sC#7NChbM_fb#W1I*fxH7HYhXqU!Y-0wj)PLh30&3%F3LypV)TIEw_6&>#X5EEp;bNmv$Y3VTI9wKFGY1t9 zqFpA)BTAl~eXM@2Qb+>}2rP=)PXV+aYtOxzHRK&>wd71v!+4jKKD_Blpbl?NW?8)_ z+v>gh3^>KUwTF-(dOSYMbnv& zXy1kT4qYK&>jK2mL^#n$t$|rTytnUupq3LOK9QynjCgkoBmT|@Xfhc1UKPeK7_Nj# z&XU#(7p9P^v4TmyQvoVpq0knrvhD;?49&$nJoz3O^Kw%mW5&ulf?5q9#=8}FiK&1# zlR8^;opN9XTSZD$u%o*Bps?|w^n6l8UMnJe&q}E@oih6aJzJo0|5IsSB-}ra={}ip zN}XnwJeM_I(Pd0^hnDN}ZMp8wo1jT;nPQ)+QB^>S34W&ke$~p{(UNSgR{r*Pzv_+S zI|;4T(e1lm_yJ*b;GObI$1}h3rm>I$_8ArSPiqx#@7&D1(@kvLqYXAtcAOuEd}qM^ zrLyZ+*7S+OiH6f4veU4a|3)xrN|Q^+Z&CoDfS*L4!qA%9o7yX6KWINhT=oj}y)YCk zeqT$yvbKb$WU zdtxadn@e|(l-2F4X-WOmO<|B3^slO;5GDu9F(!IZ$;B*R6D5fe2NntXP=dgzYhU?a zpE;AU?3pt;7;N&1SpilAOzbcTrHR^VfJGHK^{V)8T=#?(Sj;JDdS$I*kxT?{IFa2t zKMZHYG!T{yE5-zprmHGLL&QEiXVm=wFkR$;=+L!f7Ez`WX~`$Uh8Qwfl*3GR!*($B zO=fg*N{Czw(ttFj(dtNR3#Akt$5N0$HCkWP-XKCq8LN$KP3-^oAe5?oi(;Ru{U`ou zUqfhLFi=D-ApU=d_|Ogqg;prN7-OoVRg?eGZ9t&fH_%EYjwOrM{#^^=e;`d;w=fTC zEcpAkaAOqexTV{W3ER8wz@Y4Vp;V2_S&YjQNZDf?*ZvJGjHt(YMCBt=R%7KRPe`-& zFO*J#F)Hd%kMxuzM-9o6NU4!ww|3Y^Ns`+AD-|ZXfHYgz#p2o=N~z6Lby{mlf-2KK zE#PYT!^pn}zJj`VoPgD3i0mIE%`)|&(?Sgq%0IneTt9tTBBs+b#_4B#-=crt=Wkf% z=^HQUuxrX%1-wd=PEHpbKg~dA2YMBmLP6^g_?G7tWnapYfWT!y8qd0_iW*o<)NB^N&(E zJ84E z!sjP3fChxm=UN9?FLn7RXU@>_z2t6zk_N|edq8e2z|EKvRS>0P@v05PMSdfHR_!r> z9SbOqHWa+?>1P4{V1@30+)i|8lwj`Ke?i13^iX?&B%y?DN836Sp5oqh25Sf z$=78v4XJ1=9q~9Q_MC`cJBWW&_4scL0@vOWH0TM=eyx8z^Ok6k2E~5$mZ`b|Ubj$< zGnn<^K}K6Tgs^X_w%L2gDIgQ~h`K9!p>kgAk+=E7NQNWT@@ypnndnLq5 zwgpSTQ!#7?SXBaGB8v;Km%yd1=WX4!B zt4QWqGe%1_u$N6}kma{K_Ra3t6b1bX#>9Xq=u+zt=!Jq_K66GIRU;or$gAE21`_#5 z!xgP|f*Fkp^FnMc(f%#ZM_J0TA(I&RI3Au`D2n862%;DX@rJhzLZLp zJ}iX_!~7u<^^0K^(cix-;08d$XX@>0j*;byuBE<-FD-ahp!3B$C_v(&@jQwtw$Bod(!$ zI{kll(djMHpbw3nC|WX^kh-LQg(?)L6PX#QYFJ=|#ugzv>?pagj-^Mbz7aD^R!HnC zlTf0h$R`&j<0zWEk;|f7pTvv~tC}KY@&+Z(GAlUNCN}s_nVZ;|^|&!Nog_>|_EeS) z3_E&0)7P(ShMu;Mcvbu4gya|dOSOC+fGDm zgAmJnLO@^(ES=7)Gn}`uu!@LX5~~=QhR1N&EIFbgx42?;5_?C{NF$~l6=Ll%WZ2>A z%M`SF*{Qe=_Nb$6z10E5O@e9(iaV(FtcKwpq8NkPp$sJI7sGuJTyUR=--6+mX}{r~ zVBBp>+g|u`c@$l?2aI>yc36gemq*_28o3)k-Aw*=k0j?43YxTg?;z4HoinUJguSP? z$WwEMALtQv*Es`~bD>A#wmAbOkM|#dHD4Im>G2BmtSrKQWUKYpi5}#3@p-7UfmN5^54hN6ChP zk}QX8dU}~EI|FC!GfaHDw=%_i9=K&d3z^l*96c}}|CU@*1A%S>#FwyIvfE6GV{!7y zA~z2N>;xk1faH#~cS8p#_c9G#X^=aVlqC90lWw0(NB02sxKAKazgW%%bw48Fw_rK` z^;;Fl4MwtF0F8g`)?M-YTw|z4+o9ZtPB0*Aoujw`fB> z?Y&R8?JH*j>5v3y53=9rr;TzG75ws`rurQ-9;SD(A~!=eRrp7hbZ zmZ4#(|4ADmo2{KYoy?APb*&0&(ofW^tM?t~*A|zaF{|ByG?01Z4W&kP*3Y(d*mRr9 z?3WN<5lTTTYAWL0S8azS~bNrn92=rzr%heN<<) ze`#?m>z;5m7GI;aDvV5oLu%@lVO}yi&Ch7o5hHSEf^-WF}_D;?h!5C(Flj zF}%Uy&=>qFxdr1H97c^0#bR*R2KO5)*lWUWt|}<4RPo8pLW!Idm~ci^3NbIo8B%k- zTGCdZvU=vInqvB_?IcL1-m)XfVMo@7k6b7`_QJ!3&dFr=Cu)gYeUKvw@@l7LaACeM zj||cgJkuZD_6fRaqqdOp!;Vo~{`QksiO@qjBWbmJq^)+lpNdrHOIvfQ(N=c;ekFe1 zB*sk7mQv?o08Q|@f%#NxWET=_e3#f+(d7V*CatQA1Jgt1AnD-V3>^j?l{<;F*?F`{ z`&g$jMuT+U%??szpmkt7tuu_$P4$qfQi8ih_2gKlD6+$tt)X4i5J~?oYH0LgjMcdy zJ=&YTXA0=Wz8OL(ATLcJ6woJi1;o!^jAB=v*qAZiXF}<$%R?Aga5tVdYi4M(HEb}v zq!~IDx9%}@)|!u`b?XPYseR+yppI%)3w1`#r2jI~XhB`*LY>luF87inMd5=J$0#ph z?>%W{gkh&8T$)LXSJyaMi$6P1iwQuynx+u+<2wD8-<1G}#48x-XmXc{t#_)%*}(w@ zk4Ia+#~v`Qc*d$(iDt+TEBr=^y?VZvb0SDpAKUfFq%GEtv0yB7Bphr;SoLj?fRelX zpm=fq)HTa+#zkksp)cu7Z;lv89$h7$t;UAACH!*X;4e<7W)%aUE5}Hx_Q=sJlRpeN zq9u&6(xKmTNxw_T0oQ10OZ^~U@!>te^dbSj6aRO`x#BGT6W~S=i}3f~k@i-_-d>%i z3BO-TS!V~*HuS* z@AaoTKBW!W7U6VnYppDn_gBHNQix;%OOJ-ZB4te$t&0#N$%)?CEoWSN&@&{f?p|1POil)V&&?UYq_Li*(Ab;NRobp z#Xxpt#ls>Zw+`dU-X&-}_j+2{9mC=Lo+_ev{-D+ht-NoxmDiicDI-JCN%HiA3d42j zl$4RFg*zF!z1{sW@@K%vio7k1Jetr$n}KUVT^JPHkrmC)Co8b|WZspB#LtVZN;EK1 zFS>a;^p>a9(mYM~v_kjlhj)ipGv)i2OhM!ox62?peuZ2&(GF@TxyUSQepotv%7)h6 z!~Ggg)X+MarVyT$PrxI~&b7*^Rv!RI7jTAfVWrAEtQE7(70IBf7mnJyC{MyG`}iSJ z`%vqpO(fBrC1i2n@xk%nuu6BOkbRxtW2zX9NVwNVt~Pq$3Gy7xBGc0@{eX z7XrpqM&AUiJwws6wzN_16ez)ZR79s7#W#D$?~`(e<&X@q&9Y+e7?7``oSk$_LtE&k zLP56?nVm+p&r?RbZjziDh-#nf(fHkl-7h2Epj1;WX`|U)puuN)R70m3#s75g_`A|9 z(@X7U0kPD__n#phtGrIA@qH2{Qm41*wd1r+2Pz^D6_HO=Ldg~}Tvh9e(al%!YxBn~4d|1tI8etra2Qo3)Vlw9?& z#1E+uA^n&57`FeCZz0@KG68Wb?;L?%rrQM|$48!n@f;4x(pyVL{5WdFQFF;IF7a_l zRJd$|%jPCtV7kX{V|Xyb%RyNn{4aTHc+DlRap2`b36bT!G6X1;{3?beI^k4Ow`icm zBmuAnIX^`=1dQCAm0Zl6(S3LD91c*Xufu$TZ93BbSsbcJ!+h9c<+zIEM@YSphDE+` zG>VXMkf_3_QP4U^91nd|!U`k_^(wAwh@;i~qxsOmGdyAGA4@pT=?5h`wh33J=y9ql zY!CdX>}f5RVUbId-{1D7EsNU!(O^9y^Udm@Qs3A5p)D~#Mr{DEg*Lj#6<3NJR>%3! z;}(?e9k^tIpCJF2fmM=51{6bAS}gGq%x6~7O!SCjfmd;v#b(nU;YVP<@k?0{zrz80 z9k$|nqm;5BI#vY0NWlWnbScB5B18-TB7YXt2w80TC0u=iSjVLAv67xra0&KytvjJ3 zS@b9^LJ+b;Ly}sKs-b~lb_k6LF&N}x5x6FaR#F#o@Kf}JLf~&&j73-^kedaPAH+2p zAeDRti%!t^0_S*DFrw?!0ZgtQJI#;4dwS+QQ*a`Mkca9L4Gw;{niC*6)UQxz@{<%( zQ~)tca9sxSz!?^9d|{3J!?WkmpGSh#N?Z06l4YMdi>GxqV%aqo6dV?Y>aU=t%j;=(K-bbYzz%?fb zAqU%;U^q^qB8Qe1!_6tgXg*cRDu$M!vR zRZq>H5$&=YqEYtivPE=iL$-+A^vV{ITSeI-+V&z_L`%!EMP%uhEh4M3Y!O*qlNQkv zwWvnwKIVsY4i{a17&8i~c0mRiLV`@ileE=CX!MCtjEH*Kchf;50`F`KOk?|+R;l%_@}{8FE^it$iUqU z5I!(0hvZJ5uADlaO52v;gK4nf^MlDHLl{?8N_7&WvBMovQ%m@Z#QjD&i&RD;T_w0G F{686(4)y>5 literal 0 HcmV?d00001 diff --git a/.doctrees/modules.doctree b/.doctrees/modules.doctree new file mode 100644 index 0000000000000000000000000000000000000000..88c12cff84ab8b2e18bb84109ddd90244115a1a0 GIT binary patch literal 2729 zcmZ8jNpBlB6n1QDwInY|iUNsS1VuJ9mWrZ>w$~nw`cMSTDIlmBN+ir7r(9zB5TGp( zpaysgd+l%S$C=ScvVehxkB@KtzQ_5q^Y4Gdz3LZ^ZOMgNO=+GhoiiIlKi8Qrm~!!R zeEnDa7+-~fp*L20ld%}~ppkJQbHh}8AHyW6J0b0~Ip4D^b3&{3IPdT-@4b(&_#kwg zaFT6pg`QB>QO9CZfyUumwo0xy8=qnwMYp8z=^{T31JVY`4??$z?J68fp;)}~a~g)! zIV0xYA*YnXfyix&x0gw3ErfXQC|cBS{oI$E#hhl>hAong4?RbhX)E$${)CVCQ+~kD z!%s7=3pO)eDQ0Fj+FZ|?MB0CZXlHe3vqI-yGCMUE@qcx>@8?LhpXs91UgcZ$s7uB7 z;8thOup2xe;y-%eWsEsR!<0S=-2JCz>2Y8lwo-j&|PD}HRjv-Cz{HAcNjf_B=4<4$VUZ474%t)0@2ZEapY2;;n0bjeWe9P541F+4OZ(j{+l)W`Cz_AgMv0y?)G8i2srTuv}gV;{X zTgSDUYO|ch@HlB!0YH;DR-iq&t3n_0i|60{fO<~MBD-fkNjBzRtj&X|G~xA{nWBJ z&eEK)etu6+6bZai)0&FuX1O;EWL%*ISATOXOR4zacM;tXvhS`K$?i4`*S`J?)nBTbm((DdrJJR~j zhZxot?V_6~gwF-Ydr4To^LPBM4TB_bwd@Jaeau$l(lCE~-&V7OTOAW4 z!)FO#5yMfYr9@$o1FnqTFOB>&lK&Kc1N!k%1|H!v%A()3!*+1&h>u!v)v}}J%K{Kt Srfv=MG~1dnkZx-~pZ*UTxj_*C literal 0 HcmV?d00001 diff --git a/.nojekyll b/.nojekyll new file mode 100644 index 0000000..e69de29 diff --git a/_sources/index.rst.txt b/_sources/index.rst.txt new file mode 100644 index 0000000..ccacaeb --- /dev/null +++ b/_sources/index.rst.txt @@ -0,0 +1,23 @@ +.. instate documentation master file, created by + sphinx-quickstart on Tue Mar 14 18:24:40 2023. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to instate's documentation! +=================================== + + +.. toctree:: + :maxdepth: 3 + :caption: Contents: + + modules + +.. include:: ../../README.rst + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` \ No newline at end of file diff --git a/_sources/modules.rst.txt b/_sources/modules.rst.txt new file mode 100644 index 0000000..daf3e56 --- /dev/null +++ b/_sources/modules.rst.txt @@ -0,0 +1,5 @@ +instate +======== + +.. toctree:: + :maxdepth: 4 \ No newline at end of file diff --git a/_static/alabaster.css b/_static/alabaster.css new file mode 100644 index 0000000..e3174bf --- /dev/null +++ b/_static/alabaster.css @@ -0,0 +1,708 @@ +@import url("basic.css"); + +/* -- page layout ----------------------------------------------------------- */ + +body { + font-family: Georgia, serif; + font-size: 17px; + background-color: #fff; + color: #000; + margin: 0; + padding: 0; +} + + +div.document { + width: 940px; + margin: 30px auto 0 auto; +} + +div.documentwrapper { + float: left; + width: 100%; +} + +div.bodywrapper { + margin: 0 0 0 220px; +} + +div.sphinxsidebar { + width: 220px; + font-size: 14px; + line-height: 1.5; +} + +hr { + border: 1px solid #B1B4B6; +} + +div.body { + background-color: #fff; + color: #3E4349; + padding: 0 30px 0 30px; +} + +div.body > .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 { + max-height: 100%; + overflow-y: auto; +} + +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 #searchbox input[type="text"] { + width: 160px; +} + +div.sphinxsidebar .search > div { + display: table-cell; +} + +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; +} + +/* Hide ugly 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/_static/basic.css b/_static/basic.css new file mode 100644 index 0000000..e5179b7 --- /dev/null +++ b/_static/basic.css @@ -0,0 +1,925 @@ +/* + * basic.css + * ~~~~~~~~~ + * + * Sphinx stylesheet -- basic theme. + * + * :copyright: Copyright 2007-2024 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: inherit; + 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/_static/custom.css b/_static/custom.css new file mode 100644 index 0000000..2a924f1 --- /dev/null +++ b/_static/custom.css @@ -0,0 +1 @@ +/* This file intentionally left blank. */ diff --git a/_static/doctools.js b/_static/doctools.js new file mode 100644 index 0000000..4d67807 --- /dev/null +++ b/_static/doctools.js @@ -0,0 +1,156 @@ +/* + * doctools.js + * ~~~~~~~~~~~ + * + * Base JavaScript utilities for all Sphinx HTML documentation. + * + * :copyright: Copyright 2007-2024 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/_static/documentation_options.js b/_static/documentation_options.js new file mode 100644 index 0000000..d2ff549 --- /dev/null +++ b/_static/documentation_options.js @@ -0,0 +1,13 @@ +const DOCUMENTATION_OPTIONS = { + VERSION: '0.1.2', + 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/_static/file.png b/_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/_static/language_data.js b/_static/language_data.js new file mode 100644 index 0000000..367b8ed --- /dev/null +++ b/_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-2024 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, if 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/_static/minus.png b/_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/_static/plus.png b/_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/_static/pygments.css b/_static/pygments.css new file mode 100644 index 0000000..04a4174 --- /dev/null +++ b/_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.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/_static/searchtools.js b/_static/searchtools.js new file mode 100644 index 0000000..b08d58c --- /dev/null +++ b/_static/searchtools.js @@ -0,0 +1,620 @@ +/* + * searchtools.js + * ~~~~~~~~~~~~~~~~ + * + * Sphinx JavaScript utilities for the full-text search. + * + * :copyright: Copyright 2007-2024 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, anchor) + ); + // 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." + ).replace('${resultCount}', resultCount); +}; +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); +}; +// Helper function used by query() to order search results. +// Each input is an array of [docname, title, anchor, descr, score, filename]. +// Order the results by score (in opposite order of appearance, since the +// `_displayNextItem` function uses pop() to retrieve items) and then alphabetically. +const _orderResultsByScoreThenName = (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; +}; + +/** + * 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, anchor) => { + const htmlElement = new DOMParser().parseFromString(htmlString, 'text/html'); + for (const removalQuery of [".headerlink", "script", "style"]) { + htmlElement.querySelectorAll(removalQuery).forEach((el) => { el.remove() }); + } + if (anchor) { + const anchorContent = htmlElement.querySelector(`[role="main"] ${anchor}`); + if (anchorContent) return anchorContent.textContent; + + console.warn( + `Anchored content block not found. Sphinx search tries to obtain it via DOM query '[role=main] ${anchor}'. Check your theme or template.` + ); + } + + // if anchor not specified or not found, fall back to main content + const docContent = htmlElement.querySelector('[role="main"]'); + if (docContent) return docContent.textContent; + + console.warn( + "Content block not found. Sphinx search tries to obtain it via DOM query '[role=main]'. 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); + }, + + _parseQuery: (query) => { + // 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]); + + return [query, searchTerms, excludedTerms, highlightTerms, objectTerms]; + }, + + /** + * execute search (requires search index to be loaded) + */ + _performSearch: (query, searchTerms, excludedTerms, highlightTerms, objectTerms) => { + 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; + + // Collect multiple result groups to be sorted separately and then ordered. + // Each is an array of [docname, title, anchor, descr, score, filename]. + const normalResults = []; + const nonMainIndexResults = []; + + _removeChildren(document.getElementById("search-progress")); + + const queryLower = query.toLowerCase().trim(); + for (const [title, foundTitles] of Object.entries(allTitles)) { + if (title.toLowerCase().trim().includes(queryLower) && (queryLower.length >= title.length/2)) { + for (const [file, id] of foundTitles) { + const score = Math.round(Scorer.title * queryLower.length / title.length); + const boost = titles[file] === title ? 1 : 0; // add a boost for document titles + normalResults.push([ + docNames[file], + titles[file] !== title ? `${titles[file]} > ${title}` : title, + id !== null ? "#" + id : "", + null, + score + boost, + 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, isMain] of foundEntries) { + const score = Math.round(100 * queryLower.length / entry.length); + const result = [ + docNames[file], + titles[file], + id ? "#" + id : "", + null, + score, + filenames[file], + ]; + if (isMain) { + normalResults.push(result); + } else { + nonMainIndexResults.push(result); + } + } + } + } + + // lookup as object + objectTerms.forEach((term) => + normalResults.push(...Search.performObjectSearch(term, objectTerms)) + ); + + // lookup as search terms in fulltext + normalResults.push(...Search.performTermsSearch(searchTerms, excludedTerms)); + + // let the scorer override scores with a custom scoring function + if (Scorer.score) { + normalResults.forEach((item) => (item[4] = Scorer.score(item))); + nonMainIndexResults.forEach((item) => (item[4] = Scorer.score(item))); + } + + // Sort each group of results by score and then alphabetically by name. + normalResults.sort(_orderResultsByScoreThenName); + nonMainIndexResults.sort(_orderResultsByScoreThenName); + + // Combine the result groups in (reverse) order. + // Non-main index entries are typically arbitrary cross-references, + // so display them after other results. + let results = [...nonMainIndexResults, ...normalResults]; + + // 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; + }, []); + + return results.reverse(); + }, + + query: (query) => { + const [searchQuery, searchTerms, excludedTerms, highlightTerms, objectTerms] = Search._parseQuery(query); + const results = Search._performSearch(searchQuery, searchTerms, excludedTerms, highlightTerms, objectTerms); + + // 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); + if (!terms.hasOwnProperty(word)) { + Object.keys(terms).forEach((term) => { + if (term.match(escapedWord)) + arr.push({ files: terms[term], score: Scorer.partialTerm }); + }); + } + if (!titleTerms.hasOwnProperty(word)) { + Object.keys(titleTerms).forEach((term) => { + if (term.match(escapedWord)) + arr.push({ files: titleTerms[term], 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.set(file, [word]); + else if (fileMap.get(file).indexOf(word) === -1) fileMap.get(file).push(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, anchor) => { + const text = Search.htmlToText(htmlText, anchor); + 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/_static/sphinx_highlight.js b/_static/sphinx_highlight.js new file mode 100644 index 0000000..8a96c69 --- /dev/null +++ b/_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/genindex.html b/genindex.html new file mode 100644 index 0000000..54815cf --- /dev/null +++ b/genindex.html @@ -0,0 +1,103 @@ + + + + + + + Index — instate 0.1.2 documentation + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ + +

Index

+ +
+ +
+ + +
+ +
+
+ +
+
+
+ ©2023, atul dhingra and gaurav sood. + + | + Powered by Sphinx 7.4.7 + & Alabaster 0.7.16 + +
+ + + + + + \ No newline at end of file diff --git a/index.html b/index.html new file mode 100644 index 0000000..b8912a0 --- /dev/null +++ b/index.html @@ -0,0 +1,280 @@ + + + + + + + + Welcome to instate’s documentation! — instate 0.1.2 documentation + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

Welcome to instate’s documentation!

+
+

Contents:

+ +
+
+
+

instate: predict the state of residence from last name

+https://img.shields.io/pypi/v/instate.svg +Documentation Status +https://static.pepy.tech/badge/instate +

Using the Indian electoral rolls data (2017), we provide a Python package that takes the last name of a person and gives its distribution across states.

+
+

Potential Use Cases

+

India has 22 official languages. To serve such a diverse language base is a challenge for businesses and surveyors. To the extent that businesses have access to the last name (and no other information) and in the absence of other data that allows us to model a person’s spoken language, the distribution of last names across states is the best we have.

+
+
+

Web UI

+

Streamlit App.: https://appeler-instate-streamlitstreamlit-app-e39m4c.streamlit.app/

+
+
+

Installation

+

We strongly recommend installing indicate inside a Python virtual environment +(see venv documentation)

+
pip install instate
+
+
+
+
+

Examples

+
from instate import last_state
+last_dat <- pd.read_csv("last_dat.csv")
+last_state_dat <- last_state(last_dat, "dhingra")
+print(last_state_dat)
+
+
+
+
+

API

+

instate exposes 5 functions.

+
    +

  • last_state

    +
    +
      +

    • takes a pandas dataframe, the column name for the df column with the last names, and produces a dataframe with 31 more columns, reflecting the number of states for which we have the data.

      • +
    +
    +
    • +
+
from instate import last_state
+df = pd.DataFrame({'last_name': ['Dhingra', 'Sood', 'Gowda']})
+last_state(df, "last_name").iloc[:, : 5]
+
+    last_name   __last_name andaman     andhra      arunachal
+0   Dhingra     dhingra     0.001737    0.000744    0.000000
+1   Sood        sood        0.000258    0.002492    0.000043
+2   Gowda       gowda       0.000000    0.528533    0.000000
+
+
+
    +

  • pred_last_state

    +
    +
      +

    • takes a pandas dataframe, the column name with the last names, and produces a dataframe with 1 more column (pred_state), reflecting the top-3 predictions from GRU model.

      • +
    +
    +
    • +
+
from instate import pred_last_state
+df = pd.DataFrame({'last_name': ['Dhingra', 'Sood', 'Gowda']})
+last_state(df, "last_name").iloc[:, : 5]
+    last_name       pred_state
+0   dhingra [Daman and Diu, Andaman and Nicobar Islands, Puducherry]
+1   sood    [Meghalaya, Chandigarh, Punjab]
+2   gowda   [Puducherry, Nagaland, Daman and Diu]
+
+
+
    +

  • state_to_lang

    +
    +
      +

    • takes a pandas dataframe, the column name with the state, and appends census mappings from state to languages

      • +
    +
    +
    • +
+
from instate import state_to_lang
+df = pd.DataFrame({'last_name': ['dhingra', 'sood', 'gowda']})
+state_last = last_state(df, "last_name")
+small_state = state_last.loc[:, "andaman":"utt"]
+state_last["modal_state"] = small_state.idxmax(axis = 1)
+state_to_lang(state_last, "modal_state")[["last_name", "modal_state", "official_languages"]]
+
+      last_name   modal_state official_languages
+  0   dhingra     delhi       Hindi, English
+  1   sood        punjab      Punjabi
+  2   gowda       andhra      Telugu
+
+
+
    +

  • lookup_lang

    +
    +
      +

    • takes a pandas dataframe, the column name with the last names, and produces a dataframe with 1 more column (lang), reflecting the most spoken language in the state. This method will find nearest names and then look up in dataset to find the most spoken language.

      • +
    +
    +
    • +
+
  from instate import lookup_lang
+  df = pd.DataFrame({'last_name': ['sood', 'chintalapati']})
+  lookup_lang(df, "last_name")
+
+        last_name predicted_lang
+0          sood          hindi
+1  chintalapati         telugu
+
+
+
    +

  • predict_lang

    +
    +
      +

    • takes a pandas dataframe, the column name with the last names, and produces a dataframe with 1 more column (lang), reflecting the most spoken language in the state. This method will predict the language based on the names.

      • +
    +
    +
    • +
+
  from instate import predict_lang
+  df = pd.DataFrame({'last_name': ['sood', 'chintalapati']})
+  predict_lang(df, "last_name")
+
+        last_name predicted_lang
+0          sood   [hindi, punjabi, urdu]
+1  chintalapati  [telugu, urdu, chenchu]
+
+
+
+
+

Data

+

The underlying data for the package can be accessed at: https://doi.org/10.7910/DVN/ZXMVTJ

+
+
+

Evaluation

+

The model has a top-3 accuracy of 85.3% on unseen names. The KNN model does quite well. See the details here +The name to language lookup has an accuracy of 67.9%. +The name to language model prediction has an accuracy of 72.2%.

+
+
+

Authors

+

Atul Dhingra, Gaurav Sood and Rajashekar Chintalapati

+
+
+

Contributor Code of Conduct

+

The project welcomes contributions from everyone! In fact, it depends on +it. To maintain this welcoming atmosphere, and to collaborate in a fun +and productive way, we expect contributors to the project to abide by +the Contributor Code of +Conduct.

+
+
+

License

+

The package is released under the MIT +License.

+
+
+
+

Indices and tables

+ +
+ + +
+ +
+
+ +
+
+
+ ©2023, atul dhingra and gaurav sood. + + | + Powered by Sphinx 7.4.7 + & Alabaster 0.7.16 + + | + Page source +
+ + + + + + \ No newline at end of file diff --git a/modules.html b/modules.html new file mode 100644 index 0000000..2681021 --- /dev/null +++ b/modules.html @@ -0,0 +1,110 @@ + + + + + + + + instate — instate 0.1.2 documentation + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

instate

+
+
+
+ + +
+ +
+
+ +
+
+
+ ©2023, atul dhingra and gaurav sood. + + | + Powered by Sphinx 7.4.7 + & Alabaster 0.7.16 + + | + Page source +
+ + + + + + \ No newline at end of file diff --git a/objects.inv b/objects.inv new file mode 100644 index 0000000..c99aaf5 --- /dev/null +++ b/objects.inv @@ -0,0 +1,6 @@ +# Sphinx inventory version 2 +# Project: instate +# Version: +# The remainder of this file is compressed using zlib. +xڅA +1 E=E<n aچvmf5'c*v@p0 2} t98,b5T̚9?2p>PڨH:uɎ5zk$pթO}?d7׏Iv^n2 \ No newline at end of file diff --git a/search.html b/search.html new file mode 100644 index 0000000..d06ade9 --- /dev/null +++ b/search.html @@ -0,0 +1,120 @@ + + + + + + + Search — instate 0.1.2 documentation + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +

Search

+ + + + +

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

+ + +
+ + + +
+ + +
+ + +
+ +
+
+ +
+
+
+ ©2023, atul dhingra and gaurav sood. + + | + Powered by Sphinx 7.4.7 + & Alabaster 0.7.16 + +
+ + + + + + \ No newline at end of file diff --git a/searchindex.js b/searchindex.js new file mode 100644 index 0000000..4c3feac --- /dev/null +++ b/searchindex.js @@ -0,0 +1 @@ +Search.setIndex({"alltitles": {"API": [[0, "api"]], "Authors": [[0, "authors"]], "Contents:": [[0, null]], "Contributor Code of Conduct": [[0, "contributor-code-of-conduct"]], "Data": [[0, "data"]], "Evaluation": [[0, "evaluation"]], "Examples": [[0, "examples"]], "Indices and tables": [[0, "indices-and-tables"]], "Installation": [[0, "installation"]], "License": [[0, "license"]], "Potential Use Cases": [[0, "potential-use-cases"]], "Web UI": [[0, "web-ui"]], "Welcome to instate\u2019s documentation!": [[0, null]], "instate": [[1, null]], "instate: predict the state of residence from last name": [[0, "instate-predict-the-state-of-residence-from-last-name"]]}, "docnames": ["index", "modules"], "envversion": {"sphinx": 62, "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}, "filenames": ["index.rst", "modules.rst"], "indexentries": {}, "objects": {}, "objnames": {}, "objtypes": {}, "terms": {"0": 0, "000000": 0, "000043": 0, "000258": 0, "000744": 0, "001737": 0, "002492": 0, "1": 0, "10": 0, "2": 0, "2017": 0, "22": 0, "3": 0, "31": 0, "5": 0, "528533": 0, "67": 0, "72": 0, "7910": 0, "85": 0, "9": 0, "In": 0, "The": 0, "To": 0, "__last_nam": 0, "abid": 0, "absenc": 0, "access": 0, "accuraci": 0, "across": 0, "allow": 0, "an": 0, "andaman": 0, "andhra": 0, "app": 0, "appel": 0, "append": 0, "arunach": 0, "atmospher": 0, "atul": 0, "axi": 0, "base": 0, "best": 0, "busi": 0, "can": 0, "censu": 0, "challeng": 0, "chandigarh": 0, "chenchu": 0, "chintalapati": 0, "collabor": 0, "column": 0, "contribut": 0, "csv": 0, "daman": 0, "datafram": 0, "dataset": 0, "delhi": 0, "depend": 0, "detail": 0, "df": 0, "dhingra": 0, "distribut": 0, "diu": 0, "divers": 0, "doe": 0, "doi": 0, "dvn": 0, "e39m4c": 0, "elector": 0, "english": 0, "environ": 0, "everyon": 0, "expect": 0, "expos": 0, "extent": 0, "fact": 0, "find": 0, "fun": 0, "function": 0, "gaurav": 0, "give": 0, "gowda": 0, "gru": 0, "ha": 0, "have": 0, "here": 0, "hindi": 0, "http": 0, "i": 0, "idxmax": 0, "iloc": 0, "import": 0, "index": 0, "india": 0, "indian": 0, "inform": 0, "insid": 0, "island": 0, "its": 0, "knn": 0, "lang": 0, "languag": 0, "last_dat": 0, "last_nam": 0, "last_stat": 0, "last_state_dat": 0, "loc": 0, "look": 0, "lookup": 0, "lookup_lang": 0, "maintain": 0, "map": 0, "meghalaya": 0, "method": 0, "mit": 0, "modal_st": 0, "model": 0, "modul": 0, "more": 0, "most": 0, "nagaland": 0, "nearest": 0, "nicobar": 0, "number": 0, "offici": 0, "official_languag": 0, "org": 0, "other": 0, "packag": 0, "page": 0, "panda": 0, "pd": 0, "person": 0, "pip": 0, "pred_last_st": 0, "pred_stat": 0, "predict_lang": 0, "predicted_lang": 0, "print": 0, "produc": 0, "product": 0, "project": 0, "provid": 0, "puducherri": 0, "punjab": 0, "punjabi": 0, "python": 0, "quit": 0, "rajashekar": 0, "read_csv": 0, "recommend": 0, "reflect": 0, "releas": 0, "roll": 0, "search": 0, "see": 0, "serv": 0, "small_stat": 0, "sood": 0, "spoken": 0, "state_last": 0, "state_to_lang": 0, "streamlit": 0, "streamlitstreamlit": 0, "strongli": 0, "surveyor": 0, "take": 0, "telugu": 0, "thi": 0, "top": 0, "u": 0, "under": 0, "underli": 0, "unseen": 0, "up": 0, "urdu": 0, "utt": 0, "venv": 0, "virtual": 0, "wai": 0, "we": 0, "well": 0, "which": 0, "zxmvtj": 0}, "titles": ["Welcome to instate\u2019s documentation!", "instate"], "titleterms": {"": 0, "api": 0, "author": 0, "case": 0, "code": 0, "conduct": 0, "content": 0, "contributor": 0, "data": 0, "document": 0, "evalu": 0, "exampl": 0, "from": 0, "indic": 0, "instal": 0, "instat": [0, 1], "last": 0, "licens": 0, "name": 0, "potenti": 0, "predict": 0, "resid": 0, "state": 0, "tabl": 0, "ui": 0, "us": 0, "web": 0, "welcom": 0}}) \ No newline at end of file