From bd0ddc6fe9d29c7027d5e6512c92b005fafc2926 Mon Sep 17 00:00:00 2001 From: hgcgd <170009237+PES2UG23CS205@users.noreply.github.com> Date: Fri, 20 Feb 2026 19:22:47 +0530 Subject: [PATCH] Add initial Sphinx documentation setup with autodoc support --- docs/Makefile | 20 + docs/build/doctrees/api.doctree | Bin 0 -> 2455 bytes docs/build/doctrees/environment.pickle | Bin 0 -> 17678 bytes docs/build/doctrees/index.doctree | Bin 0 -> 4452 bytes docs/build/html/.buildinfo | 4 + docs/build/html/.buildinfo.bak | 4 + docs/build/html/.doctrees/api.doctree | Bin 0 -> 3500 bytes docs/build/html/.doctrees/environment.pickle | Bin 0 -> 14369 bytes docs/build/html/.doctrees/index.doctree | Bin 0 -> 4452 bytes docs/build/html/_sources/api.rst.txt | 7 + docs/build/html/_sources/index.rst.txt | 19 + docs/build/html/_static/alabaster.css | 663 +++++++++++++ docs/build/html/_static/basic.css | 914 ++++++++++++++++++ docs/build/html/_static/custom.css | 1 + docs/build/html/_static/doctools.js | 149 +++ .../html/_static/documentation_options.js | 13 + docs/build/html/_static/file.png | Bin 0 -> 286 bytes docs/build/html/_static/github-banner.svg | 5 + docs/build/html/_static/language_data.js | 192 ++++ docs/build/html/_static/minus.png | Bin 0 -> 90 bytes docs/build/html/_static/plus.png | Bin 0 -> 90 bytes docs/build/html/_static/pygments.css | 84 ++ docs/build/html/_static/searchtools.js | 632 ++++++++++++ docs/build/html/_static/sphinx_highlight.js | 154 +++ docs/build/html/objects.inv | 6 + docs/build/html/searchindex.js | 1 + docs/make.bat | 35 + docs/source/api.rst | 7 + docs/source/conf.py | 66 ++ docs/source/index.rst | 19 + 30 files changed, 2995 insertions(+) create mode 100644 docs/Makefile create mode 100644 docs/build/doctrees/api.doctree create mode 100644 docs/build/doctrees/environment.pickle create mode 100644 docs/build/doctrees/index.doctree create mode 100644 docs/build/html/.buildinfo create mode 100644 docs/build/html/.buildinfo.bak create mode 100644 docs/build/html/.doctrees/api.doctree create mode 100644 docs/build/html/.doctrees/environment.pickle create mode 100644 docs/build/html/.doctrees/index.doctree create mode 100644 docs/build/html/_sources/api.rst.txt create mode 100644 docs/build/html/_sources/index.rst.txt create mode 100644 docs/build/html/_static/alabaster.css create mode 100644 docs/build/html/_static/basic.css create mode 100644 docs/build/html/_static/custom.css create mode 100644 docs/build/html/_static/doctools.js create mode 100644 docs/build/html/_static/documentation_options.js create mode 100644 docs/build/html/_static/file.png create mode 100644 docs/build/html/_static/github-banner.svg create mode 100644 docs/build/html/_static/language_data.js create mode 100644 docs/build/html/_static/minus.png create mode 100644 docs/build/html/_static/plus.png create mode 100644 docs/build/html/_static/pygments.css create mode 100644 docs/build/html/_static/searchtools.js create mode 100644 docs/build/html/_static/sphinx_highlight.js create mode 100644 docs/build/html/objects.inv create mode 100644 docs/build/html/searchindex.js create mode 100644 docs/make.bat create mode 100644 docs/source/api.rst create mode 100644 docs/source/conf.py create mode 100644 docs/source/index.rst diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 000000000..d0c3cbf10 --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,20 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line, and also +# from the environment for the first two. +SPHINXOPTS ?= +SPHINXBUILD ?= sphinx-build +SOURCEDIR = source +BUILDDIR = build + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.PHONY: help Makefile + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/docs/build/doctrees/api.doctree b/docs/build/doctrees/api.doctree new file mode 100644 index 0000000000000000000000000000000000000000..e748e9a8f677118f8c214f18770aa64fe106456d GIT binary patch literal 2455 zcmZ8j-)kH<5KipeozK2I+xbxniQANtrlIkY{tLrf^-tJ$rI30xrHpCAxQk(jnXD?f z_VIIk_HX7R}cVtIDgxf@Wuy=gFoD15cMp6~(@I zC`RIu*cM0O=hrXie>!g6d}+?Tn9q1+srv2Jo4KyPjukED0O{rpxH&E5)HU0bE z#Mb~Nz5$3aG{=b6CWDG^k+mnS;_-FGQz)JRlK4UF0?Kv+MLgehx%MF13tfW5^Kjo= zs-2>#SfsROX}N0>)bqwu6;E%4-L(y8I94g%?J&tIo6=9ZWRKR8Ch1|vaqp#Gf=-7W zKXPld=bFXP|BI>$+3pC|HV7EP1R^c@ECL^hUNed`FV73=A+|A)e8_%yPKZSAPt*#2P%8f1Jr!a9~ zO-V9Sq;7C<_^^?1#cK&UmtK%Hi4d>7(6VY4MwXYxdZPGyj&yE?T|rfM?1e+VlE|W` zzH)1$Ug$BtsFnyfIj2@5i?Fbq7LW{4j*O=#C45pNX9Rs?7_4F#Rz5%e<=9DlKf0+T z+*)IapqeReQGowC*i*m5;6ZG5&k8$XXy6NC_+?tVGs%HFrk-iWF1Ep?Eu9G*0dhcNhqfX87 z^maH*%?8@&C0M9rA$@#v@H9+HUXpHBq{obsWI=&F^+otncwf4gCnpfQX?fv=(NklW zXr~9svIYQ4;(3Acc$8xY^5Z8z{)Bu^Y@ThnPm(M5->u!Fb7|u18Mjl(eO|}FG&m8y zPzW~kbb%IPUc}R#a0EgYr0dM?0mPMwA(!F6U1(2NM98I3_yu|ID3f?Uas@?~{avA@ z9TIh~J~v0AOh(((9%X_84+`Hj8?s!d5Vy~&5+Twqt2b0T11`ZHlS!R}1MN__o2G=T z78_==NZeJ1Hl3K3&shXziUntA-wPlRoO{H0kiqJV@PbN3uyxbWtx+GgdlOt$c{9*1 z!#3CN(-I3i%_u?df{9WyiQe$UQ@i9CO;{0!00m}w>|%^_mR8mWjJg}rX01UCZ+Um< zr+JEv2>Bohn{V+#oVYMd0)J5g;fE+*TsrX${+@`D3*+mxs&9`oiHfK2@YqOFORnu2 znAatZ9l)cu#lonr{I%)*4Pj?Jyy0=Uj#^*3d&56QtMw7R@?g_ftHFlDz{pIM#sStz zW|Tr=@doUR!RuE38IS)M--7)3zXNTA{}deR-309B#trdaC$3AjCv~POmMF4J)!Jog Nw6#+pE$?bE{U6Vp*>wN_ literal 0 HcmV?d00001 diff --git a/docs/build/doctrees/environment.pickle b/docs/build/doctrees/environment.pickle new file mode 100644 index 0000000000000000000000000000000000000000..ef7f2d8ee2d9578982a5a025c9db37625e5a21b8 GIT binary patch literal 17678 zcmb_k2Xq}*nYJaX+L9%?rz#KC4B_Z&EzM}W|K4IKgmLI?yxZ@aV*`U2a|SA(N&|NZaZ z?mvEE&#StxSi%3vvAiY1WPTz@j)Ym7G=rpQ%aO~n6>44Jw{oC@r2j%3lWF4w(R!~6xn{1+P6~2J(nJA%bx4=Aj|Q0Ha&_8 zIWQfRnIG@ny{|0?6Nb0PezPrCVFGGbqm^JRJzw4~+Sj&aZ=Tg@YB8V(7OTY?F(ih? zTGXXwRu6Q;dYa6Hvu!z~*J#SUdsKzpSWg}lC2uX5FM=cw(kS1-py19@SpiG9{w*%Q9`^jwS&jxMT6;O4Y*8Mo} zuqB#P_Nj8-_T^f&8!t%eX(LRqlYz3B+5VL6Iqhmqf+NU1H7Aaxua%`yP{$DtD#C7O z%JyR2BE?CK?b{2)IEYYWVGWz1vl!K#yn5PN$ii8H?wc>V;G&)9k1yAJplT*|$i5>u zPtd9@S76;)5C?vaZFOHTaUo6*)bbbFVy7Hn$eU>vSmkD%NSOtmp@KIP#zEpY(Qo6; zS(+BdCvG-%$8W}Q9B<3<*`O!@dVU%-7?x5fIyBY~~p`5+)}jyUsfg=eed4%=l$oco|rOXyG>+*iBNW zO%R9R0*ZjvdqR#-T{CTzU=1P<;l_%z?xi(4Wbgz|k+ElI;jD1$i0oU>4!L` z)6u8t&49{DS_EDe%mkRT9)O8_+?qwXhC3>bA*v0x7G_B-fX#{pUh|j$lf=X*_6TwI zdSl?Hsyc0{v%vul7eTXyvkGz|l^`}B^em1z-4wi97B+A;MBzYY!Ir4#P0A*Tu0^>{L0%rz0eOv}1^P{`ltUUnlV(l7VAkzJ8zMRO zctAnpPoUFRHx8$CWjH&*sGh>F;WTCcb@Z1}gAg&n_8NrG9QyAK^8#e2no^$L^ykAS zCWqKbe7X@{947b)l36TfTCT+kgog#yaKUg#>980T90u9JZ@k25NJ8C?wsxW_=0U41 zS59EwBF;Ssm2hT(>Zw!*V`fE8M^!?AdLS;e6voPNB*ozpe9TwFDSEypL-*m!vB~vr zmAtkITOPF}UEU#s3h#^bh=;9ErnuyTd-oXfM8(P0Do4rfB>5ZPBI za|wwcxtif_brD1M}Tfy>|6_1*yl@jMeCNpkW z6wTPHLy}sQTBVVE7CpoRLKJBZ?bd4}3{>k0X&dCwAwgT*Ak~DpmL9Gb?hMGao<{+{ zDU^3KY!JJz(Cg*9j+;eX9VWztkS)AK@P?;^Iz%TA(g^Z;7P1T?Vko4e{0KS9Estg) zF*`|Hj5i2n86Ja@^kXW}{`D~p__1GOEz*{2s|qX9#vGh;ergOOKL@xG#7zn&Uc-eM z|44|1p*+Op$f5QKWAXxeu5KslgES@t2~Mtu5XyX8y@7Gie1%uG8j!kBGOT;IoLoV4 zD~mcvujbCd9yORMxF1rD13d)tq=_G60y-tstmA={I3%)%b-sjZF|7dC9cME~_i{bA ztWX~BRCe9_2}n?`%Uf|+=(AhYII=Q4ZOWN3`0N#q2FKVNRex6DgfePeu9_%FVXIZr z4#99q9{5>ZkUgU2CC)WHrZvtTWm@;=c`LK$gxsvAB@L^_#3;%D1nW6X3=^ z$czB>6iw2yXqBYLjcwP%wjIO(j{&^}oeU)lNlb)PhoQ6piCJy3$gYWTGooIN5o+Kk zMFEX>SW-=4R$qrUf;qj@5R}Z(hQ5HB)M^i4epu--H9bu)65K*6gB3!O8Z$xMp?ARo zA0`H*A*Rp_f3Zh54rPc(Y7pVNvsoaYDvF|&UphHiZzK~@-U#CGNH&oK#bnZIPU^P1 zc1#BOlO{pU?agMqy-q7ZW86tIn6uMigVW-IWO&!Xt+2fhZi8^QT^b?y5az0?e?HY8 zLcQ&d<0GY|bsbi`1D1tB8S_-18BS}&pvahKoeVxOxRT`aq8u}2ax6UM>zt6MSZsCg z3O@su1@b0S&DY!5yky>Qx$^qGd&j4D@4I6BX;S*w7b>r0VW`krc8#bKTtXZ#3jo+H zrz#}fIR!Og?&8YFWi!E+wCrcHDcVvH8lHztdXcA1Y zG}vNQX!s&*x6*yvs8Eg|vs!CZRk1mwOw~1EE;*4p;rjN+(-!ONGjU z!zEd+BJkP%z~)EYTIDjpdUUWw*bE?x+EZt^*rRDSM;6RfkBjw_I!!1yn#Lch2^oZJA8(VVRc$ix9K=Wy%D^n?s$JPVDpKLJQ$ApsC?_R67SLUKyfaSF zN;5k~?)f=vg*%TMidzsSGpX0f% z!DI$`690~x8i#}XjSq&qX{wVH)_viJF_@vm?3+zRJxgJLS!a#NPh%El&2>QvTlSsz z^zDEAxF@~r88I^E*ng(K9Zg> zdF2CS4u%PbRQkzPg3AG0cSu`72_K@(%r$`g25Ib zaHqX(Yzg-x4nz>QpvIC0>?$ZY2=ofw2#%0*%g$*}kZdo(0h_C8-OIR1awXzN!&SAm zjz=oYTunRJ&Kz0Lgfpn|o2s@d4q!wVlu%XG3=?R=tXa9T8>>q02TMztCTl0lJe#bA z$)pG=*4dWM6y!UTbFABr+P0*!v+py^$-tGY(X`rt4b88irf;%4=58J(yO>d9*c z?AqfR!)lXj{21PDEr4PtvtW~HrADzq0*uoP=OLb}7AF4X7-*-O-k68j8h%(c0&IU% z-6ShBY?5qOq6G0pvgc(#|D8z48&)8V4&z3b=&-n9#MJGam zF2wGs@jyi{dA1>!t%vxrez2zuNrW;fNK?_48Y6BK!n|iAWAn+Q=ok)mOcDS#m1&|Q zZwP(BNXnoiPBArMA`r5S#@9tA_#`#_7++!l(pASV^CvuZoNqX9?lOh}dph~1bd zzc-tvv$)cBuc+K?E17LN>dvrrCR!XK6o_yK;%FFy#P~@q5QRKKHqyg3%3DD_gh+83 zooz=VmEboJ4rPa)&9GqJC#_4=uV!4P9mR{O(K!z{m}8 zvkZ8(_#*@EwaeLe!r-PYbd81fi)WkaYwbD?Sm?TGLxAhW4W{9Z;yDIh@=tBUKeNzFZ0$?M%S@LO!VZ3`f%Jm{ z#U%OpSWNPQ+xCq`+=h+5O5DbOUoBokfAuQ}i>x+!5K6tFK-I&tX^RUPryeV8BvqWt zSp8^%yBX%NZA@c*MeGB**g>tuYsKyS_jUU3>&5M6KX2G(pf_6RP2$Z4`4;h34Mso5 zt%-htA0Fx*;+>|=yQaDg_-;$G_f)*~UPCAGzNrc&Hufl z_>{dJpSI9l7J8d_yIJ37#Agk7xA>d^KQHbz;1_JKFD@F~ed0?7{Ia;;fL}Rbps!l! zYvSt$`2makh8^ge7WXX+eOr9Tbonmiofe4Sv&;Ak3;m_-^L-2bz(PM1KQf(vEFLi6 zPi*~z;-?1rGdtwZ#V-u5ziL5?Q2!7;Y#);#V$O~+x(*mYTKDZvs~&-v=XZ= z+CGgMbpd9{8g&DTR^f;7Jpfp+ntAEYA*R@X1<4J1ZO1-9Cm7ccC>p>Imj(f-wyO!h z#^8sjG;B(1sWf6rE2u>4;}OiU4j=(b*d^~|Y44w^8?fD6SqI2-W_^kl8F|-Yk4Ffag zJYW<(o@gLBKw(_4W2`2v(x9gh3C1=p6}Gi4OMtf2P3snAqQ*?Y|Q8&kMICa6@^16L^sio zMtB6jz(M$cr*$pjEjCPw_$AK1f&4NAIxF_vPMLFNu$t31s=I{-3X7&$;MBO0SU9;Y z6?lgkt=5O6GP?qfnj;Ov)~&7TlzAlARtp<{7UGO%W%AUjsR?i*;!F7{cqOpgb>h3W zl}f2PWJZc+u=r?}el!II!J&hQ0Gqwa5yX)>;^|m@lzhfW91qgZOa#@oK&F%x?G#$! zt2BpEjpm7Bry$qrK&kC7Cbh1LnoheYK_N=%N9pmXMetzs>+)b@M=QRByV7r?8sNzdb?UxC@-$8r@upRlUC|Iu{ z`Wi}hq_0z-Z_tlk<2M0YN`1>Md>e(S`%Sy=P@nJ8kM8(Ag1_$|egN2x^h3AsBe(El zx9|W8cG*91YaT=)`YHYB`F`d!Ez6o5QVATKO9h>aSMhZn81;UM_x16u=Mob`cp&;) zy+WM34KD#mW1t|sn|(d3v%sx#@7u4{yv;X%m=t!gk&@gIqSzy@!1Y;=#5+n@Rf$jL z=|}A0qKSWVX4vS_*M$y4OddcF4h}AcuB~lvp1Azp6 zJjS*{&U=0d=8kUY2GI`U2QRTSU{!M?kO(1~QE38x9mD9Vmq%TxRaB##vzALm3JmM$wV8ieju4cF<9+670 zL*R6*1CInSqzNy|e$avv6jh9On0S$%;Sv3&lxEq5$5uJSDU^6+=9nuUj3`Wr6gzsj z!+Sp^ZzE&@nl8!>b+np8$|^#`cn)Y#N;N`#C*+zI60S+_@f#}Txv697ekDanJcil+Ch{pH@Sp17;KkM*bbe z>l@hqIyX;PnMWMu=HRC2e&po&ArmjcnIe-^oQrgNN>cVrmU1ckDb|nO@KN%Wd3oRX zj@NyB_f#)mo0s=}>jo~B^sxYCRv{=)Y5sCG@{nTlWFc4US2HAD6?B0)Nf|tXhTU{? zZf(;|mi_v5snL#ZrAv7mez;-?>3Ebo;m1e)g`7kPFXokUqetoLl>bLGM`{8kV2gl) z<(pO79#x!N*-ue>I&3{t8#CcM9<@B4vX{@Q+BlyoKh91h^n4ES#VxRQ{khRV<{wpZ zk1`JX>jGZ`A<+c>Tl5|t{yIvi#O{Z7@4tHdTJtdjwoacb(JL)l7wzc%Xq?x4Ip`#= zkTmKJIV%O3C;BUqL-fSU-&z3bN7`~#pbQJJDKSJT`wAaPEXdrB-ix8jnv!_$1FTja zeE=XrDj&ojEcPS#BR4z7G$`nV#ME-5JJBk-4?kFH^hx|Bq55h3#R#8Kf9_U)?oog4 znuwvHH8%j57mrGy6mwlI{ps(d~|fAyQ0!D zAPRc1fHDh}Dg@tf+8dv^*r^Hr8=^X&*{_JEkLApMVTX9|u@3Qo9pZIbT1;r6!PohGjPxjkfMP`6WgkQye;9U%9(~Cyd?|f-rWJune2p%_1U`MtHm|?e z=zF&n4!;M^<129yz?Aw8Bw^sColC{aA|4l3cJAIS$H!m9=0 zYb*b#nI(EAQHu=~Jkbt|jq(zFC3-#da(<9M5Iv|QCcarbSb6XVNqHVrTH#=2ohkxs zWBNY^=}C7$4WW)OcoekP@}RnjgMY{>%33Lrs#K@1sq8m?#=OQ09G&sh%2Ezf8z+qu z`i@aZQdg%z;$MzvUc)mFf0IZ^9s)XrIUtuK%o1eDXUJ2e?`_e9>c}Rb*siv zVZJ460m&Wwu@|KkI#_%dOdrUx89)klWgUZUm8ZhM^LomgdKzk}v z4fN4Am9us2s5<+$VvBI(fPzDb`(SRBvI}2#5dOuO5QosGK8x+3_bPVRoJK?V9?wHM zyw2k>!!Giui={mU`j)fm7QK_Fu(jRf(>c}V?7GRR175C%mp@Ahhbp7QEU{PTf>4uw zB&8`IG`b6;!<04Oqw5$fnDDylV`c;k<`v!^(|WHy+lbag7aFflYm5KF(0*7+q~1xmCWy(W~tO{MSXI&*Yz7m&Hj zm!ibifa(iE>wJ@AF`++Nlp|N_oWbjp@bKlzCjo6<(Z=0v#7ZYd4`O^dbU8k&Bqy4B zLV{mXZqkwr<+@oTyE;DpxKq1 zfgv|^)*-{O1-VC)o!VK$!%+sLso&gLPi|&4<&w_KjE-`F)7P<9h%-u_BhoHYWfu$a zO46QWh59EBRP@ZGjKS20E}u}y32F)Pxvv5F0yGQ^`kcy0Cwy4IpJ}`Kb^T6i-Kg@? zIX|w-svBOCP{)x{Iks#%-A0OsR0(!YCf({KNp#UYh!ajnpXc9u`S%O-TdE_jHa)g{ z!rYirjT{3oxpEw7g#bRMh(u*k5iwGa%vn$U**u!#JF`9(UB83vRpdc zP-i9_hh^pPk~}z$&Ek`%WwYPL-0U`+_%`ZdP0m|KQ=9I#Zuv~N;ggcw>?eB0OXr|2 nKHXJ`mTt0|xakn?Q1vemxao=~vD&vCNiI}jWI`)@1sVzCB9%0+ zo?&vw>1!@jzc$cLifm~;YuSGvQzMBu_}$}AqsBhbyvU=BC{1NF;(|Vm5=n`sX*8U6 z!?_Ng8=jmgO{9*X{8aMjDIG>1Jc{1``0&xM4nO<_zCZY7zx!ojqJ-oTNlB?A&A9R= zBb=oaR8ujHbP-K)iAeA>o{t|!L!%?EBgG0M(un9tP@JWk6uBlmhYcFZqR`Q)E)p#% zJ&jT>X`=Z#?N_Y*tYRH|{R=vAj{5(*;5U_vyV5VeTVwZ+*@I&< zBPu2^mXLvcv5U}d^-Rm zWRX#Td31Uz>E~LSL>oy{2iMcnNKJw9Nk96WQit>IOFGf7nbxH`91JclF8XyY!lV5{ zjt4X!gsdGHMaFc1_{}!Z*kBOc&2%Pya~gM>5Qcmo6*5XGG7N;_-L}tq_RUuuzM8x3 z@uJ&Y=mZCE5V7ckn?H2fCN_JkepoPmv}pYGG5G{Bd5k#pZ0{vEE?8VWZU@k($Rr@X zp;gf0$^X*vKjz}`kGr_N?z7Uq>_fYbiy6r)`}C(lj0gU++Q}We4(cD%c`bs|KKaSO z89dZvpu62NkSo$;+ImkF-`I(;oa{FdGKywGWQ z!t=w1t9gaV(*>jjR%2Jdu%Vc}JlD9PxpG59?6z(Bga*xnRwVc2er(rB$*VtC#BT9C z5hkUsggbU;{~&fFBa@VtnpH>FP#sW{9n0FzlfX^t5JWr{#jv`x>x`!C6$Qu z3itk{@oBIFuAaxj-kH~#gC%-fK+J;9a?1mq1&;qY_E}rz`1wYwv6z)Wwr_80NpdAT ztHz})#z1eV$}L@J5To~5t>ay2oL{cmoy162)8o3F9^0)(;%nov-B46(6c2QRJ$F6d z-HoJ=U5cLI4@4M*x*;;VUKm{(T^+N*vF(g$4r11YtT0H?&!K(GN(?q#JB6bHDU-@x z9aMHR93jTOXHe+YLn8%7+lW!@x&}9kqqJPSret>4_+shLxEA5`U z0Dz|${3Co1w=GCMHs}T5?i4-UHRQ8>1I=173IIlq)h6?jrRm+fAMz=eBSeh0O3t2cz4yTHJ7-z3slR3A$59c?gWN zmLlGpV655j=&J3xWCLvSF;FOY#&z}S-hI1M(lVYE5OTkUx(c7Xfi|!rH^%T7i)WcRyFeVe{7btRdd`^fF%$UtR=jYy-%=T#cky$B zlvZ%m8-5&yu_zJ}%8I?0Ff_gi0w0nMUiL1;>N8WKCb*ZVFA_BeprSy+^ARvmlfn(h z63Pr$)OhBwD+&@a(Y+DQDnJI+Cq?>BaRNrsg@o09W>rdUQpAx{T z7zIMRv}-g!uTVPdMxYYpE|7?7>K~GE=xzLqsE0!VSsGjm)S#F;Dz`V5q~R?EF|3Vd z1J{7LXBgydCk)^F?0fbd`-)AC?Kr8PmN=$+YkYsnzItKUTkiWiJTIn98N0n0Id5w_ z;fTLG4D1JqOVCCy9C}d_^zZ;gq_bfmW?=BDH&=u+?aq?LPP40DbYscB|1SURPRBvDruwl-!k~P-3^Gv|gnQv**n244E@?oSBo4 zi$X;TEev?kyjqh0BN^NaN9H$ePeAW5aCepqA5)%6#jXU#xXljAa(?JMOzt zW`g@kHQaar)SmvBiW6)`};m62m<(P_dKlcTd8NA&PY))q`&0IdWo6k&5TNwHWmT01~xBe9?R;~TkODj^Wuy90&AYMB{{RmbUwgaC$JKxqN9ImrE~ z5zHv<*u>^D-wC``Swi+l+9dfi-?d;(N+O+vY_KqRzLYS@3JKX0j+2^1xUV`;v1;I# z4NJ9gM6z85cb@QzoXTd|@~doLz>AK$%+^XR--_8V8{@j}9yJPHgoa@>fuxOaL@Ych z;1dcyBgh*aLo4^~%#GGRS+@e;7mjWcW{ft3Qx!{Q5P<+Sa=BkAJwIWkRanXW+SJaJ z2~K>sGHk#?(oFGCTmpvmE}Bco3K`sTyZ=%;4@A>k}w0{u zJohKcIPDn^0ugml;yp!cnJ-b-5%`N3?S7TEr>vAn;|f!OMjU zae609aYg85MTe?tz;m!iM?#IjfvPB+3RS{p!zne91nx>r%S;T-XD0_`k|B$cz6U_S z8FRSfYy_>}e+|Mwz8=9D3C`$=)7fci?7RU`p95rKx z(u5YV3Q%B{LoY@-k3-9Pj8b<*TDCQaVQthb=0ZJ1M}&Mn2+MDNgKt>h4gzm3(D`8GbN%Xo0pOHC^+U>F;wh<;r;ZJ()2{ly370L|d232J*0Rayz8!o-Ckw*7MCI_JN6 z4VG6=zB@$o>dE&Lc(C=4h;X98^fyy)#8u6Dm~MV6r<(!47{<9~T$-M3!f^5n)PH`H zl5bVb__&`9yhahZJ^1Wys3l=u+?t)3kb=P<4+p(sx|+>~{HJm(uETqk|5^+Ddk@u) z(tB#c%i)$I;b>fb^)<@Ve(HmK#oP-lzyCL1yae1fx~l-asU$;G!<|V6-s|^!hvD7a z?3E)c!N|JU>-9F1P{EAdEEbtUxYv(}EZ2MMLUCr0`WWChYdZb^hD#s71%KK%kifUm ztvAb_fwqO}%FHe+2IW6+_9b8A*RvseEr}X_%+&m7eR}`?UF811B*;9h`%}#@Q5S`x hI4w2eqK+>K70E0PePbL-_+lL9ooX})an6SQzW@uNVY2`L literal 0 HcmV?d00001 diff --git a/docs/build/html/.doctrees/environment.pickle b/docs/build/html/.doctrees/environment.pickle new file mode 100644 index 0000000000000000000000000000000000000000..3245535a3160e38378c55dc25185df528c2d7d61 GIT binary patch literal 14369 zcmb_j378$nQP%Eici-NJZp+8|Udi6KvSd3xgJemTot4(Ij@Yp!kLSHNZ+m9v%{8xXMC@!$C)ih)XbI>)We1wVAj4gX-?fS71Ig^1CTAY z)H*=Q-gXpvP90?LSHzfNYV_D?B0^Ai{K#PdCa~Zna%*W468*+>C#xQ|mm+sgp!?R{ zyLR7x^TfrP_Z7{=F4=n)XMlZWa$P2SBgc2_7~AUFRlNliPr`=1l!-mEk4sjwm0*=y zLA^9`EJFpW>H1D!x6p6%Q&AWu=c`W{-1( zC?>{5?<7j=36|QRsk2y)I*WBbZ8*f37)hPxs2f}e?A*B%r#IMens(|ZRuuXU?c8oO zu=b!%OU57(L_|2Wx@9>^xK`Lm!3abQf{iC(-3n`Tq~HLY8AGqS5NgE&R8a%sNP8M# z%XV=nSD;VJYJ#Rgm^fDCG#$)Ycfc|>_<2PRa!17$*zovSjaJF#mxKUq0JUk3F$6&Wav6`0Gr%cMrj$1 znP7cJk&t4Yl%1Xp(LX1w{j=(O;*rde6}}nhGNCqIIACZ27I_DxQEY92p@kj0F@)d8 zf<@>zs0T#IX{R;X66?W3dn@`n>}NRSn-tr6s(_UXm{k&&5eB;r?AvX+4m5Rd8q5db z0v0mBxVX;a;F_y&J#`xyDr$~;h}p9px;6)#gW51RgjBG8<%>nl(+-LAp>r8FOxK}R zho;OyYL!OU<=`P65Xwh$XqR3aL2%72%e+C1JHpAt!%|HMv9uswkQtC`BaZ@pQy^=> zZ4kS!)9Ynfhhz~~y8$sFvt3c#RY`g?3ou3-RXv{ut1a%XFi3hpTw9mR& z80te@_e#_rWk{Uh9;@dQsmY;vB0Gm|QsZKIR@!brx#BM23w7It2qIRR)Io1GVGN$A z+2B`bFf|UY8_*;SY#$TQ(Ezi72U0qaXzkWn^3-D54rCk$GEc&|ky{oZi?=5`Kl(wO z1LNYh?l6D9#3u4EP>Vk|6 zH7~KN=`pKe#V!M8vV8f!qjNAH5QJS+*QKun>z z{8o#^40Y&4YT!Y}$%4=1-6Bca@m~UiRi~ApF$B>JR@&*XfoUDV%Kg+N4C+%mpwaU#4HtX}8&u&RC;VyP^X@o4x~cR9 zhZXOEIblG?=G13Kd|*Iiq4PxyJ}|J9l=6xkH+5K5p{1OTWqDZ+E#xk-BS2XTZ!u_C zt4VIylFh#D{*#9fPt5K+a&Y3FgGcr~czEx=0|$;BJbwJukmRD5awx3CA&+O{;eE4* zPVPH|E{6~A_1$V1&7t`KS!9cr)^$C&=Tg>y3ak~@sH(v?!|}2LfU&Y&0ZHamsRgSR zBJZcI09)RsfJxZ)owJTlmJAVx{FPa`Q6VqXDhggw_?T$GZ6IyQ5(iXjVK@&Umefw~@N#HZ1tG92LOO zV83xPMxf%?fJf_=vP$NiB`{Ni+D^(|7zS`0Xti7ln^+x$4fa(pX-}VA?LM*r-GFXX zculyR;AgNv@-@11O^x7*6pxX>9KW8B)^Z6xT$ z_IEWQUTVHkYJ@8?ox>`_c^JR&;tCiu1ckH!p7iXqwlY&+a@cJMIJoVS4_345^9XRn z0s~#$UP2Hju-LK-&OmdMtI%M7SO*MN5EJLItYj2Dk~MR^h*HE|A<0mX&*tlN&|Z4Cl}sbXLdlYDKG55$Iujt~HLdB~JuGOjjG*@lcY#cif|djWmbtN~stt~15!#SNx-hq%)e?^=<)+G3$u?_M#8d&IrE zC@T~IphuQP2P%V&CAoZ{A}^OZf3m#n0T%L>i#cp5U&1-@llmt|9%&5@mLT^>HP+&gN4UY=H1+dv9O?UZ{rwJ+ znN57>4paKBy!74TdkpY<#rNr=HxJ42eEi{|eo(x_w0Y-Dmnr^GPO^6uEcL^NPU1&q z)|r;?7Vjx-gtWa5dhqD))eHSG{rz$AK8F8<_(^86_luw6?+3(B)7L~dn3nSL;!$7% z0s0AJp(;;?+vkohn_6@N|A$`UXOtlPtor<%`h36m0ba@n#n1Ei7sM~}_e0{B`1@hi z?3Y)#_ABC7`TK(S2!B7i%%6{`&&S0lxcZ~2`fIAsudCW8)#o?FZ*rU85_|ajq8k6V z)#rCqqu*7Z-&3F87k|J_|4{r9fB#s4|3v&LSN}|P{d4gbT>VQ7OoI7Ws@13TJfFsa zk;eS%Ts}UdmiJllH;njO@pt_Fd+`ta{YUXn{QYMhKKE63=bk5H|3yvyugl(3N;7{h zFa6t!f&F{VR-YGNFdXzn@g;-*5AkJPl!MxV3SffaR4eTUg5NL^;q`-0Mika?1Y33D zUIeuBceEux$huBhfJGcs*UKH9L~4R&qVMl zxyvXu8Z%wSskXt?Hd1Yqscoj(7E{|wwQZ($845EUJm7XJUdhGFso2fMD^OIsy%Htw zD*R#i)hO)X(lsdM-V#Hu1w>KeI#ZH;+9*l7u+p6c!;nh+PdtFrRnGStS-t}e} z?*>zn8)CTbu>2@8oJS6ofU=9i&eK|6DNhQuUG)xju3IOsdMI$nV{|4;(b|cyIgvkA z4jpmhy5mEU!(WZ@#>(vD-H6qAlla5i-a)mUrgjqwif}g*e9FM9C@A7g=Ph~!*+TcTZ>1esZ!vr=vJyxz9FE=|;!pKd939AiueOb%C90PmJ zJINzBI8{_$i;DLM{n3C&srzyiB zPNTA7nmtj%l)aT0ktpSy!X#De!~1IP%&=z(+akw}6gXve$dO`U6A!=^H!G9di>Ag2 zfLBBhH}ItM?UsC?yp?)uJZ(nuEG*u8lKyB4+ElKU0CkkjUgao!E%pjZ))c+NG7!gu zmssOv1&U zMNJWF!|Nf!OC9isIgY9!DrkT=or%dC_uRMx1q2H5%nWz3NLm=y2^G0&=sl|Q8S<2h zual)Awoo1ioQ1t_f?tH!EP4f24-3Y%5_@F@bWqRh&(d3;-FEX_fal~WJ9_Zj$N^y? zI8VV1@)S7@W#AE9SqK>(1pt{S2zInx&K7tRX7=6z$?)DyO0SPiwgU4`08@;vN2Lka z`^4y~*L$fewesFaO+nB+v4U1GstKcFP;s@M&2-7FYk>k;B}gVf$ge|gS&MXWFyy8K zXYzFN(U68S)0d~-7_c%s(SF;Sv5JTWEn~wPECuGXnNGQB4O~SWvYGW4%uneS=&*KK zanc}gj~XYN*_+CZI+8$7d0;Q~fQ8t|_$oLaSn&3~A}gQ;z51z_;9(BOBh01q1Y{?I z8FGljKs zBsm9luFWKJ#eWFKi^Pa6F%) z#hW>F;o`Y1B0j?V7R5Rm*#3s{B zuxOo7*B99fO5xE{UZpOO?}i92EI#k^Jp2iIsl>L2_8on2;+RPW!k#H1Pxh$%q0IXd z8pkzT_Lm~Uq=vd&4)-FYt8=OlChk_s6r~E10E!BQF2SF~390N&Y($5V2jP7IL#H*R z>b{7wTDkXS6cJMT3O-ou*YJ^BOE)km$WJLsg{kFw9bGt?5&XeYy-s{do36(fBlM_G zMSc3!XOKUsH;k`dNGkjN5GgL?9~YEn0;o08_$iV>%B-h|IZ#W%Sn44+KY}$IVXF7h zQ?G^4YU>iskmRQlC!tjI$&Q(4VjPJ*7ujvPZZ1kIHASuoF4c@ldeLK7bli=7zC1dT zkf=B(bU+UlkVdY$1Hm`^p2R0E_Gp6dBC7M5O%Y9B$(h}h4{_rw9pd_Yh-+Ty5EI-{ zvB%XYU-VdRxCCO-yZI6r@0Lp;UWPcF#u)z}$4I8gOC955nClxn#z%Mv?~+v92|SdC zQmh4QYc-*j28;7qw0s##KrtfkvKMA3Csv+@Ez0)bn<;Zs-vH)C*?S`_xks{ZKV^ZyoV^RrUUPm}!~NMK+y-tTl!o+JIiR9mJdC(^*3HlVLK%Y_?6B)jz3bX$d-I}M=t#GO^OBDfP z8u67#BFTUnLLH&=GH9>$K_Q7JzL8a=wG^qPxM4xlJV(~p)d+{v8P9a2$Vf$-()%dx zI|d>9L!Abxe>tjo4KY{F=_Mc!fjfmcAeN)d5@f7m9dNP zcQCiFhQvT{wW;6dAa@$|ZgyBvfH{P#953|b8Nd?*udvdd_1?wwS#7ew_a@IlWJyydwJwYMh2C#su15m};Ppwy8>6 z*V*c&edlV6VB~p%Ly6a6Zly?brM*vjFJeL*La$0IUq$cr?5C9)4I#VLLY@gTgX&Jh zuJEWUX?_Zn8C`VqKF3q!*e-JBN@#O-UF6LHE(hS;&lQPWW{Ew>yL9kaN=+)r|5eVX z*S((X!u*#OI&cFfJW-_nBSx^eq%MctS)_NyfZnoUpgzcn{%^@@Z-I?!lE&c*w3nvx z8f?!BrovV3_2cUe;ExrRf|uYZwoGH}lvP(BH0^K1s$ZTPB@cO%A^LkEzgOx`o~i1jIqBfXXqJ$#*P zNR}bku#W`9(#j4>4te8n;wejoup6PBDU(y@apWes+_D-$vnw|Poi?q;wGfu*pz}myr9+zd{(Njg!X@+1F_cutGMkhFC~BvXC|h%m5OsER~F|gcZN0N=P4e zbL0XAq!qe;LaEPPO~Rz=q>H_eH~AMR&^9V3%f%gq#f_^Ql4AfCC!cZ@VMLuAu3MG- zhBb^(i9$do_XAecn1RJUl5*%LHdug4#3o0ZIAX};W+5nuJR<}yasdBuh_j&q9_7ff zh1_Nfc_e89W9yU9KxqxXmq;Kc^dl||Hw*}JfH<>_GU{ZK9NGTSqnl?hbZqu_c2BtXIu*wDpcXQ4y8s_P* z#!;8MAZEKcAvX$<)Ez&q8&fDguRpDGmk~b0&m;^FajIi2T!eV9h(}LD=!&2GP{76< U*0LOM0}ARw`q`O=X;!QLFQ@|iiU0rr literal 0 HcmV?d00001 diff --git a/docs/build/html/.doctrees/index.doctree b/docs/build/html/.doctrees/index.doctree new file mode 100644 index 0000000000000000000000000000000000000000..26af2094740ec633a5f4b94951c4c08f33ea9180 GIT binary patch literal 4452 zcmds5TZvD&vCNiI}jWI`)@1sVzCB9%0+ zo?&vw>1!@jzc$cLifm~;YuSGvQzMBu_}$}AqsBhbyvU=BC{1NF;(|Vm5=n`sX*8U6 z!?_Ng8=jmgO{9*X{8aMjDIG>1Jc{1``0&xM4nO<_zCZY7zx!ojqJ-oTNlB?A&A9R= zBb=oaR8ujHbP-K)iAeA>o{t|!L!%?EBgG0M(un9tP@JWk6uBlmhYcFZqR`Q)E)p#% zJ&jT>X`=Z#?N_Y*tYRH|{R=vAj{5(*;5U_vyV5VeTVwZ+*@I&< zBPu2^mXLvcv5U}d^-Rm zWRX#Td31Uz>E~LSL>oy{2iMcnNKJw9Nk96WQit>IOFGf7nbxH`91JclF8XyY!lV5{ zjt4X!gsdGHMaFc1_{}!Z*kBOc&2%Pya~gM>5Qcmo6*5XGG7N;_-L}tq_RUuuzM8x3 z@uJ&Y=mZCE5V7ckn?H2fCN_JkepoPmv}pYGG5G{Bd5k#pZ0{vEE?8VWZU@k($Rr@X zp;gf0$^X*vKjz}`kGr_N?z7Uq>_fYbiy6r)`}C(lj0gU++Q}We4(cD%c`bs|KKaSO z89dZvpu62NkSo$;+ImkF-`I(;oa{FdGKywGWQ z!t=w1t9gaV(*>jjR%2Jdu%Vc}JlD9PxpG59?6z(Bga*xnRwVc2er(rB$*VtC#BT9C z5hkUsggbU;{~&fFBa@VtnpH>FP#sW{9n0FzlfX^t5JWr{#jv`x>x`!C6$Qu z3itk{@oBIFuAaxj-kH~#gC%-fK+J;9a?1mq1&;qY_E}rz`1wYwv6z)Wwr_80NpdAT ztHz})#z1eV$}L@J5To~5t>ay2oL{cmoy162)8o3F9^0)(;%nov-B46(6c2QRJ$F6d z-HoJ=U5cLI4@4M*x*;;VUKm{(T^+N*vF(g$4r11YtT0H?&!K(GN(?q#JB6bHDU-@x z9aMHR93jTOXHe+YLn8%7+lW!@x&}9kqqJPSret>4_+shLxEA5`U z0Dz|${3Co1w=GCMHs}T5?i4-UHRQ8>1I=173IIlq)h6?jrRm+fAMz=eBSeh0O3t2cz4yTHJ7-z3slR3A$59c?gWN zmLlGpV655j=&J3xWCLvSF;FOY#&z}S-hI1M(lVYE5OTkUx(c7Xfi|!rH^%T7i)WcRyFeVe{7btRdd`^fF%$UtR=jYy-%=T#cky$B zlvZ%m8-5&yu_zJ}%8I?0Ff_gi0w0nMUiL1;>N8WKCb*ZVFA_BeprSy+^ARvmlfn(h z63Pr$)OhBwD+&@a(Y+DQDnJI+Cq?>BaRNrsg@o09W>rdUQpAx{T z7zIMRv}-g!uTVPdMxYYpE|7?7>K~GE=xzLqsE0!VSsGjm)S#F;Dz`V5q~R?EF|3Vd z1J{7LXBgydCk)^F?0fbd`-)AC?Kr8PmN=$+YkYsnzItKUTkiWiJTIn98N0n0Id5w_ z;fTLG4D1JqOVCCy9C}d_^zZ;gq_bfmW?=BDH&=u+?aq?LPP40DbYscB|1SU`_ +documentation for details. + + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + api + diff --git a/docs/build/html/_static/alabaster.css b/docs/build/html/_static/alabaster.css new file mode 100644 index 000000000..7e75bf8f9 --- /dev/null +++ b/docs/build/html/_static/alabaster.css @@ -0,0 +1,663 @@ +/* -- 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 { + margin: 1em 0; +} + +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; +} + +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: unset; + 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; +} + +a.reference:hover { + border-bottom: 1px solid #6D4100; +} + +/* Don't put an underline on images */ +a.image-reference, a.image-reference:hover { + border-bottom: none; +} + +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: 940px) { + + body { + margin: 0; + padding: 20px 30px; + } + + div.documentwrapper { + float: none; + background: #fff; + margin-left: 0; + margin-top: 0; + margin-right: 0; + margin-bottom: 0; + } + + div.sphinxsidebar { + display: block; + float: none; + width: unset; + 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; + min-width: auto; /* fixes width on small screens, breaks .hll */ + padding: 0; + } + + .hll { + /* "fixes" the breakage */ + width: max-content; + } + + .rtd_doc_footer { + display: none; + } + + .document { + width: auto; + } + + .footer { + width: auto; + } + + .github { + display: none; + } + + ul { + margin-left: 0; + } + + li > ul { + /* Matches the 30px from the "ul, ol" selector above */ + margin-left: 30px; + } +} + + +/* 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; + } +} + +img.github { + position: absolute; + top: 0; + border: 0; + right: 0; +} \ No newline at end of file diff --git a/docs/build/html/_static/basic.css b/docs/build/html/_static/basic.css new file mode 100644 index 000000000..d9846dacb --- /dev/null +++ b/docs/build/html/_static/basic.css @@ -0,0 +1,914 @@ +/* + * Sphinx stylesheet -- basic theme. + */ + +/* -- 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-top: 10px; +} + +ul.search li { + padding: 5px 0; +} + +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/docs/build/html/_static/custom.css b/docs/build/html/_static/custom.css new file mode 100644 index 000000000..2a924f1d6 --- /dev/null +++ b/docs/build/html/_static/custom.css @@ -0,0 +1 @@ +/* This file intentionally left blank. */ diff --git a/docs/build/html/_static/doctools.js b/docs/build/html/_static/doctools.js new file mode 100644 index 000000000..0398ebb9f --- /dev/null +++ b/docs/build/html/_static/doctools.js @@ -0,0 +1,149 @@ +/* + * Base JavaScript utilities for all Sphinx HTML documentation. + */ +"use strict"; + +const BLACKLISTED_KEY_CONTROL_ELEMENTS = new Set([ + "TEXTAREA", + "INPUT", + "SELECT", + "BUTTON", +]); + +const _ready = (callback) => { + if (document.readyState !== "loading") { + callback(); + } else { + document.addEventListener("DOMContentLoaded", callback); + } +}; + +/** + * Small JavaScript module for the documentation. + */ +const Documentation = { + init: () => { + Documentation.initDomainIndexTable(); + Documentation.initOnKeyListeners(); + }, + + /** + * i18n support + */ + TRANSLATIONS: {}, + PLURAL_EXPR: (n) => (n === 1 ? 0 : 1), + LOCALE: "unknown", + + // gettext and ngettext don't access this so that the functions + // can safely bound to a different name (_ = Documentation.gettext) + gettext: (string) => { + const translated = Documentation.TRANSLATIONS[string]; + switch (typeof translated) { + case "undefined": + return string; // no translation + case "string": + return translated; // translation exists + default: + return translated[0]; // (singular, plural) translation tuple exists + } + }, + + ngettext: (singular, plural, n) => { + const translated = Documentation.TRANSLATIONS[singular]; + if (typeof translated !== "undefined") + return translated[Documentation.PLURAL_EXPR(n)]; + return n === 1 ? singular : plural; + }, + + addTranslations: (catalog) => { + Object.assign(Documentation.TRANSLATIONS, catalog.messages); + Documentation.PLURAL_EXPR = new Function( + "n", + `return (${catalog.plural_expr})` + ); + Documentation.LOCALE = catalog.locale; + }, + + /** + * helper function to focus on search bar + */ + focusSearchBar: () => { + document.querySelectorAll("input[name=q]")[0]?.focus(); + }, + + /** + * Initialise the domain index toggle buttons + */ + initDomainIndexTable: () => { + const toggler = (el) => { + const idNumber = el.id.substr(7); + const toggledRows = document.querySelectorAll(`tr.cg-${idNumber}`); + if (el.src.substr(-9) === "minus.png") { + el.src = `${el.src.substr(0, el.src.length - 9)}plus.png`; + toggledRows.forEach((el) => (el.style.display = "none")); + } else { + el.src = `${el.src.substr(0, el.src.length - 8)}minus.png`; + toggledRows.forEach((el) => (el.style.display = "")); + } + }; + + const togglerElements = document.querySelectorAll("img.toggler"); + togglerElements.forEach((el) => + el.addEventListener("click", (event) => toggler(event.currentTarget)) + ); + togglerElements.forEach((el) => (el.style.display = "")); + if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) togglerElements.forEach(toggler); + }, + + initOnKeyListeners: () => { + // only install a listener if it is really needed + if ( + !DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS && + !DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS + ) + return; + + document.addEventListener("keydown", (event) => { + // bail for input elements + if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return; + // bail with special keys + if (event.altKey || event.ctrlKey || event.metaKey) return; + + if (!event.shiftKey) { + switch (event.key) { + case "ArrowLeft": + if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break; + + const prevLink = document.querySelector('link[rel="prev"]'); + if (prevLink && prevLink.href) { + window.location.href = prevLink.href; + event.preventDefault(); + } + break; + case "ArrowRight": + if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break; + + const nextLink = document.querySelector('link[rel="next"]'); + if (nextLink && nextLink.href) { + window.location.href = nextLink.href; + event.preventDefault(); + } + break; + } + } + + // some keyboard layouts may need Shift to get / + switch (event.key) { + case "/": + if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) break; + Documentation.focusSearchBar(); + event.preventDefault(); + } + }); + }, +}; + +// quick alias for translations +const _ = Documentation.gettext; + +_ready(Documentation.init); diff --git a/docs/build/html/_static/documentation_options.js b/docs/build/html/_static/documentation_options.js new file mode 100644 index 000000000..e21c068c1 --- /dev/null +++ b/docs/build/html/_static/documentation_options.js @@ -0,0 +1,13 @@ +const DOCUMENTATION_OPTIONS = { + VERSION: '0.1', + LANGUAGE: 'en', + COLLAPSE_INDEX: false, + BUILDER: 'html', + FILE_SUFFIX: '.html', + LINK_SUFFIX: '.html', + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '.txt', + NAVIGATION_WITH_KEYS: false, + SHOW_SEARCH_SUMMARY: true, + ENABLE_SEARCH_SHORTCUTS: true, +}; \ No newline at end of file diff --git a/docs/build/html/_static/file.png b/docs/build/html/_static/file.png new file mode 100644 index 0000000000000000000000000000000000000000..a858a410e4faa62ce324d814e4b816fff83a6fb3 GIT binary patch literal 286 zcmV+(0pb3MP)s`hMrGg#P~ix$^RISR_I47Y|r1 z_CyJOe}D1){SET-^Amu_i71Lt6eYfZjRyw@I6OQAIXXHDfiX^GbOlHe=Ae4>0m)d(f|Me07*qoM6N<$f}vM^LjV8( literal 0 HcmV?d00001 diff --git a/docs/build/html/_static/github-banner.svg b/docs/build/html/_static/github-banner.svg new file mode 100644 index 000000000..c47d9dc0c --- /dev/null +++ b/docs/build/html/_static/github-banner.svg @@ -0,0 +1,5 @@ + + + + + diff --git a/docs/build/html/_static/language_data.js b/docs/build/html/_static/language_data.js new file mode 100644 index 000000000..c7fe6c6fa --- /dev/null +++ b/docs/build/html/_static/language_data.js @@ -0,0 +1,192 @@ +/* + * This script contains the language-specific data used by searchtools.js, + * namely the list of stopwords, stemmer, scorer and splitter. + */ + +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/docs/build/html/_static/minus.png b/docs/build/html/_static/minus.png new file mode 100644 index 0000000000000000000000000000000000000000..d96755fdaf8bb2214971e0db9c1fd3077d7c419d GIT binary patch literal 90 zcmeAS@N?(olHy`uVBq!ia0vp^+#t*WBp7;*Yy1LIik>cxAr*|t7R?Mi>2?kWtu=nj kDsEF_5m^0CR;1wuP-*O&G^0G}KYk!hp00i_>zopr08q^qX#fBK literal 0 HcmV?d00001 diff --git a/docs/build/html/_static/plus.png b/docs/build/html/_static/plus.png new file mode 100644 index 0000000000000000000000000000000000000000..7107cec93a979b9a5f64843235a16651d563ce2d GIT binary patch literal 90 zcmeAS@N?(olHy`uVBq!ia0vp^+#t*WBp7;*Yy1LIik>cxAr*|t7R?Mi>2?kWtu>-2 m3q%Vub%g%s<8sJhVPMczOq}xhg9DJoz~JfX=d#Wzp$Pyb1r*Kz literal 0 HcmV?d00001 diff --git a/docs/build/html/_static/pygments.css b/docs/build/html/_static/pygments.css new file mode 100644 index 000000000..9392ddcb4 --- /dev/null +++ b/docs/build/html/_static/pygments.css @@ -0,0 +1,84 @@ +pre { line-height: 125%; } +td.linenos .normal { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; } +span.linenos { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; } +td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } +span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } +.highlight .hll { background-color: #ffffcc } +.highlight { background: #f8f8f8; } +.highlight .c { color: #8F5902; font-style: italic } /* Comment */ +.highlight .err { color: #A40000; border: 1px solid #EF2929 } /* Error */ +.highlight .g { color: #000 } /* Generic */ +.highlight .k { color: #004461; font-weight: bold } /* Keyword */ +.highlight .l { color: #000 } /* Literal */ +.highlight .n { color: #000 } /* Name */ +.highlight .o { color: #582800 } /* Operator */ +.highlight .x { color: #000 } /* Other */ +.highlight .p { color: #000; 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: #000; font-style: italic } /* Generic.Emph */ +.highlight .ges { color: #000 } /* 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: #888 } /* Generic.Output */ +.highlight .gp { color: #745334 } /* Generic.Prompt */ +.highlight .gs { color: #000; 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: #000 } /* Literal.Date */ +.highlight .m { color: #900 } /* Literal.Number */ +.highlight .s { color: #4E9A06 } /* Literal.String */ +.highlight .na { color: #C4A000 } /* Name.Attribute */ +.highlight .nb { color: #004461 } /* Name.Builtin */ +.highlight .nc { color: #000 } /* Name.Class */ +.highlight .no { color: #000 } /* Name.Constant */ +.highlight .nd { color: #888 } /* Name.Decorator */ +.highlight .ni { color: #CE5C00 } /* Name.Entity */ +.highlight .ne { color: #C00; font-weight: bold } /* Name.Exception */ +.highlight .nf { color: #000 } /* Name.Function */ +.highlight .nl { color: #F57900 } /* Name.Label */ +.highlight .nn { color: #000 } /* Name.Namespace */ +.highlight .nx { color: #000 } /* Name.Other */ +.highlight .py { color: #000 } /* Name.Property */ +.highlight .nt { color: #004461; font-weight: bold } /* Name.Tag */ +.highlight .nv { color: #000 } /* Name.Variable */ +.highlight .ow { color: #004461; font-weight: bold } /* Operator.Word */ +.highlight .pm { color: #000; font-weight: bold } /* Punctuation.Marker */ +.highlight .w { color: #F8F8F8 } /* Text.Whitespace */ +.highlight .mb { color: #900 } /* Literal.Number.Bin */ +.highlight .mf { color: #900 } /* Literal.Number.Float */ +.highlight .mh { color: #900 } /* Literal.Number.Hex */ +.highlight .mi { color: #900 } /* Literal.Number.Integer */ +.highlight .mo { color: #900 } /* 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: #000 } /* Name.Function.Magic */ +.highlight .vc { color: #000 } /* Name.Variable.Class */ +.highlight .vg { color: #000 } /* Name.Variable.Global */ +.highlight .vi { color: #000 } /* Name.Variable.Instance */ +.highlight .vm { color: #000 } /* Name.Variable.Magic */ +.highlight .il { color: #900 } /* Literal.Number.Integer.Long */ \ No newline at end of file diff --git a/docs/build/html/_static/searchtools.js b/docs/build/html/_static/searchtools.js new file mode 100644 index 000000000..2c774d17a --- /dev/null +++ b/docs/build/html/_static/searchtools.js @@ -0,0 +1,632 @@ +/* + * Sphinx JavaScript utilities for the full-text search. + */ +"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, kind] = 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, + }; +} + +// Global search result kind enum, used by themes to style search results. +class SearchResultKind { + static get index() { return "index"; } + static get object() { return "object"; } + static get text() { return "text"; } + static get title() { return "title"; } +} + +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, kind] = item; + + let listItem = document.createElement("li"); + // Add a class representing the item's type: + // can be used by a theme's CSS selector for styling + // See SearchResultKind for the class names. + listItem.classList.add(`kind-${kind}`); + 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 = Documentation.ngettext( + "Search finished, found one page matching the search query.", + "Search finished, found ${resultCount} pages matching the search query.", + resultCount, + ).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, kind]. +// 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.setAttribute("role", "list"); + 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, kind]. + 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], + SearchResultKind.title, + ]); + } + } + } + + // 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], + SearchResultKind.index, + ]; + 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]], + SearchResultKind.object, + ]); + }; + 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], + SearchResultKind.text, + ]); + } + 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/docs/build/html/_static/sphinx_highlight.js b/docs/build/html/_static/sphinx_highlight.js new file mode 100644 index 000000000..8a96c69a1 --- /dev/null +++ b/docs/build/html/_static/sphinx_highlight.js @@ -0,0 +1,154 @@ +/* Highlighting utilities for Sphinx HTML documentation. */ +"use strict"; + +const SPHINX_HIGHLIGHT_ENABLED = true + +/** + * highlight a given string on a node by wrapping it in + * span elements with the given class name. + */ +const _highlight = (node, addItems, text, className) => { + if (node.nodeType === Node.TEXT_NODE) { + const val = node.nodeValue; + const parent = node.parentNode; + const pos = val.toLowerCase().indexOf(text); + if ( + pos >= 0 && + !parent.classList.contains(className) && + !parent.classList.contains("nohighlight") + ) { + let span; + + const closestNode = parent.closest("body, svg, foreignObject"); + const isInSVG = closestNode && closestNode.matches("svg"); + if (isInSVG) { + span = document.createElementNS("http://www.w3.org/2000/svg", "tspan"); + } else { + span = document.createElement("span"); + span.classList.add(className); + } + + span.appendChild(document.createTextNode(val.substr(pos, text.length))); + const rest = document.createTextNode(val.substr(pos + text.length)); + parent.insertBefore( + span, + parent.insertBefore( + rest, + node.nextSibling + ) + ); + node.nodeValue = val.substr(0, pos); + /* There may be more occurrences of search term in this node. So call this + * function recursively on the remaining fragment. + */ + _highlight(rest, addItems, text, className); + + if (isInSVG) { + const rect = document.createElementNS( + "http://www.w3.org/2000/svg", + "rect" + ); + const bbox = parent.getBBox(); + rect.x.baseVal.value = bbox.x; + rect.y.baseVal.value = bbox.y; + rect.width.baseVal.value = bbox.width; + rect.height.baseVal.value = bbox.height; + rect.setAttribute("class", className); + addItems.push({ parent: parent, target: rect }); + } + } + } else if (node.matches && !node.matches("button, select, textarea")) { + node.childNodes.forEach((el) => _highlight(el, addItems, text, className)); + } +}; +const _highlightText = (thisNode, text, className) => { + let addItems = []; + _highlight(thisNode, addItems, text, className); + addItems.forEach((obj) => + obj.parent.insertAdjacentElement("beforebegin", obj.target) + ); +}; + +/** + * Small JavaScript module for the documentation. + */ +const SphinxHighlight = { + + /** + * highlight the search words provided in localstorage in the text + */ + highlightSearchWords: () => { + if (!SPHINX_HIGHLIGHT_ENABLED) return; // bail if no highlight + + // get and clear terms from localstorage + const url = new URL(window.location); + const highlight = + localStorage.getItem("sphinx_highlight_terms") + || url.searchParams.get("highlight") + || ""; + localStorage.removeItem("sphinx_highlight_terms") + url.searchParams.delete("highlight"); + window.history.replaceState({}, "", url); + + // get individual terms from highlight string + const terms = highlight.toLowerCase().split(/\s+/).filter(x => x); + if (terms.length === 0) return; // nothing to do + + // There should never be more than one element matching "div.body" + const divBody = document.querySelectorAll("div.body"); + const body = divBody.length ? divBody[0] : document.querySelector("body"); + window.setTimeout(() => { + terms.forEach((term) => _highlightText(body, term, "highlighted")); + }, 10); + + const searchBox = document.getElementById("searchbox"); + if (searchBox === null) return; + searchBox.appendChild( + document + .createRange() + .createContextualFragment( + '

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

" + ) + ); + }, + + /** + * helper function to hide the search marks again + */ + hideSearchWords: () => { + document + .querySelectorAll("#searchbox .highlight-link") + .forEach((el) => el.remove()); + document + .querySelectorAll("span.highlighted") + .forEach((el) => el.classList.remove("highlighted")); + localStorage.removeItem("sphinx_highlight_terms") + }, + + initEscapeListener: () => { + // only install a listener if it is really needed + if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) return; + + document.addEventListener("keydown", (event) => { + // bail for input elements + if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return; + // bail with special keys + if (event.shiftKey || event.altKey || event.ctrlKey || event.metaKey) return; + if (DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS && (event.key === "Escape")) { + SphinxHighlight.hideSearchWords(); + event.preventDefault(); + } + }); + }, +}; + +_ready(() => { + /* Do not call highlightSearchWords() when we are on the search page. + * It will highlight words from the *previous* search query. + */ + if (typeof Search === "undefined") SphinxHighlight.highlightSearchWords(); + SphinxHighlight.initEscapeListener(); +}); diff --git a/docs/build/html/objects.inv b/docs/build/html/objects.inv new file mode 100644 index 000000000..bb83eb02d --- /dev/null +++ b/docs/build/html/objects.inv @@ -0,0 +1,6 @@ +# Sphinx inventory version 2 +# Project: Neural-LAM +# Version: +# The remainder of this file is compressed using zlib. +xڅA +0E9\[w]=M 4{{i{0Z>頠9F{0;heWzP"V$b˚ i5_lY* ]sn{xg6AS.G&l0)kV[%$^'f= \ No newline at end of file diff --git a/docs/build/html/searchindex.js b/docs/build/html/searchindex.js new file mode 100644 index 000000000..e62d752e8 --- /dev/null +++ b/docs/build/html/searchindex.js @@ -0,0 +1 @@ +Search.setIndex({"alltitles": {"API Reference": [[0, null]], "Contents:": [[1, null]], "Neural-LAM documentation": [[1, null]]}, "docnames": ["api", "index"], "envversion": {"sphinx": 64, "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": ["api.rst", "index.rst"], "indexentries": {}, "objects": {}, "objnames": {}, "objtypes": {}, "terms": {"add": 1, "api": 1, "detail": 1, "refer": 1, "restructuredtext": 1, "see": 1, "syntax": 1, "us": 1, "your": 1}, "titles": ["API Reference", "Neural-LAM documentation"], "titleterms": {"api": 0, "content": 1, "document": 1, "lam": 1, "neural": 1, "refer": 0}}) \ No newline at end of file diff --git a/docs/make.bat b/docs/make.bat new file mode 100644 index 000000000..dc1312ab0 --- /dev/null +++ b/docs/make.bat @@ -0,0 +1,35 @@ +@ECHO OFF + +pushd %~dp0 + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set SOURCEDIR=source +set BUILDDIR=build + +%SPHINXBUILD% >NUL 2>NUL +if errorlevel 9009 ( + echo. + echo.The 'sphinx-build' command was not found. Make sure you have Sphinx + echo.installed, then set the SPHINXBUILD environment variable to point + echo.to the full path of the 'sphinx-build' executable. Alternatively you + echo.may add the Sphinx directory to PATH. + echo. + echo.If you don't have Sphinx installed, grab it from + echo.https://www.sphinx-doc.org/ + exit /b 1 +) + +if "%1" == "" goto help + +%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% +goto end + +:help +%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% + +:end +popd diff --git a/docs/source/api.rst b/docs/source/api.rst new file mode 100644 index 000000000..129007b2f --- /dev/null +++ b/docs/source/api.rst @@ -0,0 +1,7 @@ +API Reference +============= + +.. automodule:: neural_lam + :members: + :undoc-members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/conf.py b/docs/source/conf.py new file mode 100644 index 000000000..3d45aca76 --- /dev/null +++ b/docs/source/conf.py @@ -0,0 +1,66 @@ +# Configuration file for the Sphinx documentation builder. + +import os +import sys + +# Make project importable for autodoc +sys.path.insert(0, os.path.abspath("../../")) + +# Mock heavy ML dependencies so docs build without full environment +autodoc_mock_imports = [ + # Deep Learning + "torch", + "torch.nn", + "torch.optim", + "torch.utils", + "torch_geometric", + "torch_geometric.nn", + "pytorch_lightning", + "mlflow", + + # Scientific Python stack + "numpy", + "pandas", + "scipy", + "xarray", + "netCDF4", + "zarr", + + # Plotting / visualization + "matplotlib", + "matplotlib.pyplot", + "seaborn", + "tueplots", + + # Misc utilities often used in ML repos + "sklearn", + "tqdm", + "yaml", +] + +# -- Project information ----------------------------------------------------- + +project = "Neural-LAM" +copyright = "2026, MLLAM contributors" +author = "MLLAM contributors" +release = "0.1" + +# -- General configuration --------------------------------------------------- + +extensions = [ + "sphinx.ext.autodoc", + "sphinx.ext.autosummary", + "sphinx.ext.napoleon", + "myst_parser", +] + +autosummary_generate = True + +templates_path = ["_templates"] +exclude_patterns = [] +language = "en" + +# -- Options for HTML output + +html_theme = "alabaster" +html_static_path = ["_static"] \ No newline at end of file diff --git a/docs/source/index.rst b/docs/source/index.rst new file mode 100644 index 000000000..47225fa98 --- /dev/null +++ b/docs/source/index.rst @@ -0,0 +1,19 @@ +.. Neural-LAM documentation master file, created by + sphinx-quickstart on Fri Feb 20 19:07:45 2026. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Neural-LAM documentation +======================== + +Add your content using ``reStructuredText`` syntax. See the +`reStructuredText `_ +documentation for details. + + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + api +