From d6b8dddeccea4ed20d63576f6139e3133c65f1a7 Mon Sep 17 00:00:00 2001 From: "Estrada Irribarra, Rodrigo Andres" Date: Tue, 22 Oct 2024 14:54:43 -0300 Subject: [PATCH] feat: Add Sphinx reference generation --- docs/Makefile | 20 + docs/make.bat | 35 + docs/reference/.doctrees/environment.pickle | Bin 0 -> 27138 bytes docs/reference/.doctrees/index.doctree | Bin 0 -> 46752 bytes docs/reference/_sources/index.rst.txt | 111 +++ docs/reference/_static/alabaster.css | 663 +++++++++++++ docs/reference/_static/basic.css | 914 ++++++++++++++++++ docs/reference/_static/custom.css | 1 + docs/reference/_static/doctools.js | 149 +++ .../_static/documentation_options.js | 13 + docs/reference/_static/file.png | Bin 0 -> 286 bytes docs/reference/_static/github-banner.svg | 5 + docs/reference/_static/language_data.js | 192 ++++ docs/reference/_static/minus.png | Bin 0 -> 90 bytes docs/reference/_static/plus.png | Bin 0 -> 90 bytes docs/reference/_static/pygments.css | 84 ++ docs/reference/_static/searchtools.js | 632 ++++++++++++ docs/reference/_static/sphinx_highlight.js | 154 +++ docs/reference/genindex.html | 269 ++++++ docs/reference/index.html | 228 +++++ docs/reference/objects.inv | 7 + docs/reference/py-modindex.html | 149 +++ docs/reference/search.html | 117 +++ docs/reference/searchindex.js | 1 + docs/source/conf.py | 37 + docs/source/index.rst | 111 +++ examples/example_usage.sh | 4 +- poetry.lock | 330 ++++++- pyproject.toml | 4 +- 29 files changed, 4185 insertions(+), 45 deletions(-) create mode 100644 docs/Makefile create mode 100644 docs/make.bat create mode 100644 docs/reference/.doctrees/environment.pickle create mode 100644 docs/reference/.doctrees/index.doctree create mode 100644 docs/reference/_sources/index.rst.txt create mode 100644 docs/reference/_static/alabaster.css create mode 100644 docs/reference/_static/basic.css create mode 100644 docs/reference/_static/custom.css create mode 100644 docs/reference/_static/doctools.js create mode 100644 docs/reference/_static/documentation_options.js create mode 100644 docs/reference/_static/file.png create mode 100644 docs/reference/_static/github-banner.svg create mode 100644 docs/reference/_static/language_data.js create mode 100644 docs/reference/_static/minus.png create mode 100644 docs/reference/_static/plus.png create mode 100644 docs/reference/_static/pygments.css create mode 100644 docs/reference/_static/searchtools.js create mode 100644 docs/reference/_static/sphinx_highlight.js create mode 100644 docs/reference/genindex.html create mode 100644 docs/reference/index.html create mode 100644 docs/reference/objects.inv create mode 100644 docs/reference/py-modindex.html create mode 100644 docs/reference/search.html create mode 100644 docs/reference/searchindex.js create mode 100644 docs/source/conf.py create mode 100644 docs/source/index.rst diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..d0c3cbf --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,20 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line, and also +# from the environment for the first two. +SPHINXOPTS ?= +SPHINXBUILD ?= sphinx-build +SOURCEDIR = source +BUILDDIR = build + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.PHONY: help Makefile + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/docs/make.bat b/docs/make.bat new file mode 100644 index 0000000..747ffb7 --- /dev/null +++ b/docs/make.bat @@ -0,0 +1,35 @@ +@ECHO OFF + +pushd %~dp0 + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set SOURCEDIR=source +set BUILDDIR=build + +%SPHINXBUILD% >NUL 2>NUL +if errorlevel 9009 ( + echo. + echo.The 'sphinx-build' command was not found. Make sure you have Sphinx + echo.installed, then set the SPHINXBUILD environment variable to point + echo.to the full path of the 'sphinx-build' executable. Alternatively you + echo.may add the Sphinx directory to PATH. + echo. + echo.If you don't have Sphinx installed, grab it from + echo.https://www.sphinx-doc.org/ + exit /b 1 +) + +if "%1" == "" goto help + +%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% +goto end + +:help +%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% + +:end +popd diff --git a/docs/reference/.doctrees/environment.pickle b/docs/reference/.doctrees/environment.pickle new file mode 100644 index 0000000000000000000000000000000000000000..8c850df84d0fdd824c497831eed1aaf51014bc92 GIT binary patch literal 27138 zcmd5_3z!^7an|de(w$BZ%aSEaC&@-9S+{FTwy`l7$$A+3q_ePOo0k}7cjsS=@Hzn!0)$5r5)uesfB*>uLP*GqgoK2Igyc*3J_xVy#vvj3tNJm$ zw|CO+$-?NT~%FOGxzeY$G;ye;(uawQuBlA*_>BB9mG+!;#Jdz7`me# zluL&!&|{6AKixRj7!ga|TCFiI`b$wUjXkdv#0{}l;i#uUIp@^e)Gr5xhUj&Ur|~i5 z8jm%^3-b3RUYz9Ps1yg2k(Z>gTXOSfqIfE)xkWEO8Ki!_kSj)&eC+DtB#q+fV(d<& zaUMM;`2r0r@28b=KBtC|G+x=bw;{TdxJaY%`^1qar>`Wc$3;(JFGkggV6q_w)LeDG z`+zJk1nNq>w9X{*&Zb^938HG!I0?!bN}o-0Zas}Kd{A1VbBg7lIF&<-h9`QBQ(QqX~_7MHP#b zII@icxJEi|3>96??AV zbK~yemb!ge9e=0jIgKR;0UBZvh8%lk&rL9^rAO~N(GXoAfjiyscZ)twITMu>16&U> z*JIDoL~tg8vR8F0Xt(a6IEvD9xrcPwxracpa}6;(>7^->j$1BAXPk-pgAYzSV6bXZ zc2iz}8L`RAJDAaA>?H~4?k0(sG-gD9#Z6K#c6eF3f@;Y-ORLR1;3V~liQp_YfLNA` z6WSqYoyPTIilLUM>qa7mytBn}z2wmj0482`F%(o=flGGn!osa6c@u8EoH}t-_GspA zsf4jti!@{)iLn=bk4AT13{hDnD%HUQL=1whPNSj|6=*fF_-Pz4bW1DLNqkU6B22K< zrKsWtSd^>Lrs7P1rqw9*oY=o#rvG_Q4Nj z;t8{0SZOseuufJS)#OTmhJ&eBsbOWjgoOq1bH8I?#L_zB6yl(SjW8|-raZ6aoN?nS zSe(YPDyi3MyoLq{Jga%c3gV>GHKxfrP>xp=EL^D&aWPk{Cv}YFbi7(njwaCy=fE5? zx0>lgVg`%tOq5-8d>%vq)!cX*oFd7%q&5wPkoydrp!Yl`x}xG%YuLz%Q;*9)-&+mR z8aDbg(Nd+IV6qy;9*t#fGYAVZ2_{5AceP$2=`$nN$dr?KMWmdPSA%#RTPy|?d?Jb~ zZpxCn2X%<#nB#Go8oriRU+yog(&1n-$Dpp%Enqc8?+JP`s2{S#8!bS}OriaeAW1=X zDyfUBEAH8#g3cjdsxEB+ryNxA<5edym~pWZBk&yzsDSN+9Z8GDAnz2&4u0byj*I2G z9!>3hmQB1`LoCjr-?W@K5Fx?DG?i1X2*!-lgqErfed2()P*}i~U`f(bb?`B74J+%o ziVRCn9mFKp+C^%|CQPtCEmowwUJ|+xQV;shfpPgf@c;>D)<6(zSQltREHGpO3jhzK zkxcG@y?r+c5{QB_2JA=W61BjF@@n-0O^K!Ao%?!~7Vc*_b~}l=Wt0IcXE4XwJS!O- zlrZmLBJd!wd+ODxYIFtzSVhTXvg!yR7jvPyoP_bkR4)M zI@n&=Ga%Pm#sYqmAm>a_B6eS-#>;yhJBzqFs1g%Gw(tQWj zkU%JLZ1Dn=G32T3q1B3}qaH|O0+8V3atNW=HN{sj z40a`N2E|d&w+6}D*M7Mfc1nFhp3D~3Hf^{LxBp&D?kSD6TWpqHRgpxIkNQy%u zdr;&}CjfO?W9Q9Z5INsntIu8WO0hylhAy#<{NB@0PRgp`XR zwE&4(WuS;9xnYe_jYbPK@RM981-DpIcA-aKgf_x<*sTdlc4tX#Kt*af2Qa@!dJR=K zsX>BUNM*1>s7BgM@ZX|l!2%y92BaanPz-;gLpu(6h)1drV!P8Bq9Jbc)3la6BcCsp zs<|*JdF9}AoU3|izFMo~Ro#7i^ImdO9@HGIRLY}88VM?6Pikb=Ob0bgi3^h9OI|e6 zz|T$ychjU4fDd7u%JLUd`AL+U=2$*bT1wYp#Cu^`XplBW)tV6>Xb@TLtdqe98dfLy zJR?@?Je>_3)-q^$m4RmaE_Gu-Ss-7ji+Ou%3zy9J4TtYLa%6aX|ItIk&pdQ=|6ND+ z?LT<%-b2Ta-;SM}wUP%77+-D$d~;;~_?`FdzY|T49NAY6a#1{q>dVPgJFCTBH&kAo zg`os1*)=3{I2~enSpdLp*(iau=VYn^a~E5_T(49y<$D#18;u-!`gZJh*Jg3M^GRkDc9A!Xtc2lN)AXbM0u z70x&1D2}5u3D`mP$@;)n(TWxl&a4bt4AI_!X2$NwEWV8yP^(awn{_!>CZK7=M;mNJ zoHv3Pgks4%n6)P>oovMo87THn)yZ=8J(ukdOn#MJDvu1X9xZ4ZR6NL{#@J>XO2>4v zV8*&^s9P;UJCZnBpP^MiYm!S|ycMcxc)luR5VC!|Q*6rW#NauIkqVT79@3rr;*UzF zg;h_U`07=8NC_VFXfJKI@OZT-HaHT;O>m}&raa=m0kE<>8?g~FBd#Jq#hrpCkgQ1O zZKQBcrX7l15L723r?77Nn9h|(jj(3X zxRe3kq*?mU!v2Aon5LxORu-M0GI+ zj4Rnuc3oD;?OVnSBbU0RZSDCuH03NFhF^EaWZrUGk z8WA0_0r>PorVNv@**Il`k>MofwCM+<^%OJ?h|c~Y_Ta$6QZRL9>8iqVKMhT9gKgEd zimVTIijhGBUj}wo7w6H4%AlT{ipNKLY-3n$Vuf4AX}91(v6ESFrLHBh7$*VnRD!b* z&sh!a|FR6Ujk-1ZA-2XjEW?2FgD$R+l^Ik>wzJsbansm{3E|KNRP<#n#WlL2DaS@M zCqhS>RPaoayCUm_D#L>jz|duNyS^2R@@9xG-V3lUbQR@;f)fDdLJVnnl`aXYK71M} zc^c&uN$hUWrR3A{;?r>TO79?BF?=v>I(PS4t2W|a<6kS5!iC@XnTG!~e@FQ8#fugp zIRYQ-GU6hF@A7wsuaNNT{N1|BsGrlxdY#r} z7aum`xYMMbGp-46mw&geIOZSG$)mohaLlBhYntEdAJ;Wcm@e=0@7G8lFr$2)Nj=|G ze1ZQ$-Fo}DzZ;}_k$;k(FE+KE83w$>cllZHi~KB^A$VhpHIfN`QYUK$!6{QSHn7AD z0T(Q~$!P;TV=A6CscBRCp#P9=@>2htPQFTaque-j5@Z*>e=QIAyzy-Luf{}Y{8#hy zXMI6W<$Fql6i!F9AdvK2VGqz9gujDf(nVy>um05xRj#Uf0Y_o%BVAd7vxB+6lWO~~ z@gL^rBkK96|FE9K&+XKy*P7I0enSHv_kUg`!V)&DikXTR>hQzw7J|4o(D zz9}ZExZ1kg8OCkPFk}s%D&*-?w=w<+wvcH#+HC2+%j}QeGO6D-sbBD4r$_j1|2;bS zJN|oh@^}6B>E!!Os}Ia**zfrt)X5L|AJ)m=Kd)1NU{W9PKdOPhVt{{W5Pi(RK5kNf z~*NW?TM~nb+t2f7ZqS;(tLW|JDCDo%|2~i#quw-MMjZ z>@m&?UFXZXj{l$M!`Db9@fDN$>Wqec&2ahG{cmW7{xAQVy8K)Iw^dTCP$%yyY@w26r3&KF2a6aDN8k5@^Qew8F!i4g>Q~3&$^{-xt#RBn>M7d{GJr5-}isORDFU) zsqTk%8P0Ac9OJn3zh&hgp6A^E`2Wk#AIZZ13m4H|$1uaiwDXtf+)~OdQ#t=T{&%@f z4?%l%oj%I-tDG1#)08&UIi7vEoGPu*O$I18sB7i`D7RYY)=+M(&Rv1T*kT^T zI!bQllvGn%h)P`kR zZY>kma+a{c(azuDjxAOz6Ao)c;Z~gzYZ91tI3&O}fq|!-%x2f~ftHWjvl*nRXXuU{ z;R8z+EfQPqse0sK@P;j`ZaA74Hn-gaM}ws3m7z`G-bfmHY}+uRa65i@^4C!ATAh0u z5|Vs72tK0WJCTqi+GT27M>TfSk2Jl)QA+15Kpttmd&29f;0CL7k6pT#3U0JYZ=&?g z7U1cWzQqFUM_S8?@D3_CV3i)E^dSpyn9_Gzfaf4>+TVqYoZ#IiHD*^hLSQ}9qjqN8 zu6B=ABCg0zJnDR>EC$hMN?<^S#~8yItSU0kMJBwLeiYz1rB7IZ`;Z=2rS=gMM?$Q9 z2{-i33_1#J*wEPSw;G2J*qP@cGo!0L-zu?Bx7YCAwUEC+~-dUN zcrns?vSJ8_b3R5|MjhSgGY|`eJAHjDH8sSbB@nP>rId4kR_m4UC00hPRL4()z`s^$ zqR_SKg#~27BK^DqKj4QFr9BHULFq~QQTxuPbYKBON>5pUGNmgPpo+BFnGqG#tkP4I zjx9h!>C^($DSg@koT2nt3owne>ES^;^AIw6Cy5PqFc9t^ts|~Iq`I2z;Tmm((Q z&71Z;__vB)EV~R$c?6C<6+iQ+7-Am?TpD!x;|&id^dR|A5F(aS&N|U|EJ}j2#{i{J zu|BqkInIW94nG1}fan^HfsnBi=A0}FKS|}FiHSBkhY_g2Dg=p9kVcX#HpZ5U^=jS* z=p)h!$8ET~7mF)r7Y1~zii=p3>DVpP5J7NbeJ1ctgQX#l`f4Rj@0mA`hOuT=PZgT@ z*b;HYEV%TxHO7{;^iMHJXfS(NNm?Rsx5U#J+gBHBl^2aXDc}%!c?-Yb>LxfY7ZHLo zBYHs#y8I?@#|V6GbQJ{`uL_qDOW?>81AIM?rE_Jp*)sA%;eLahLhvP1U=R*wpy`ab zqKH~k2#0_h+kvNzJ zX6Pz?L6CUm3A*l_Le+lXMKl-RWzkK^I(FNE`QV=hAK`A7{Cp)$e~lf3BGm+YvDk&< zFTHqR)_^`0V@(mI;9reUEee2fbOcOY^um?JE+#A`Z=qNBeBkD3FJyNE{x)HS-gO0wC(C zcd=^hS69_uX3s>XFaLZXFcQQj@;GE0dQTEP?x*i%lEXk7UYo zwXLm)40kD1k0zp51zDCF;SZn;!XM&?gMtSTXF!)iZuyKmoixC&%(stYhQD6gY zc-*;AWSQ^L{qTAjk3a>jg}oKr$&sW{Jw1V*#4@#2WE?UJ3KF2)6-yMJd#*~?0&s(K z1#BY~QQa52XQVnMb=_O^5#fvrG@PQs4ND382?`X!M%?j$SH`WFH=IVpmfg4`Y4+}H z#r~vNZP6_wJ{#dCph*g@=(n!wNWL!(_#O^-Z7K>D_jg@Vi6hmEK&>o8cS?Mxei9*o zJ*kUpJH)DmR{?dskcj?rgy=tVKAD-zZV?;@H@BvSoYC?^9r8v7vlu#rn}G@rkS%!N zlqqZWQM`+TeNdUN9$W@8fF0^Z5qOmjmcjhp$=I!tRUwJp+==SL=!E&IZNrc{rGB^r zjlwbffb!u8o}hTR3s0=;Zu!W`$My2Dhabet@*W6!q8mf2$ARLcetBudg!gyX!yC~c zyo-Lgufs^yJL*fJIA~DpV-(>t@R*Zc2T*{;mpdk-mRvGTTOL-4aJD~dIRi5EL=UW0 z4rK-lu2B2h1Zec)hEhcoE&2c3z@?W}y_znD^5QMRECw4rc|OFXkfp6PJzX*KC&@K5CtGa>^FX>61Re6P5VtopeYV$-tACA&AzwGh(6rqf015^TUwE>V)NV-yRJC;b}gb)?35g*n?@H#6o1EbRhx#y<2lm-!@Db8|+392`j$ z3`Q}q>Sa)R&6SRIa(SkJsWa24Wrh9DN!s4oMBIGw6`pf~EvxQzKEyUxz0fgcHMmTs zI*j7UwBaty9&0W3C}7`noL>`DybdF}M5cJWW4g4v?RU4q6xp;|SmCvu53EgAc%);@ zKY6Uc_aU}?_{62N!pAzM%ahIuJgpX1_(4PKB_YGHv5oe!!_7FgFY=BJzmR$DB9Z;Q|iuT4yFQ#i<^4<6r!!AFO{F#aswSkZmS)@~nA zTpnw8-jmO~vukCG?#@ToCR;4+81qxk7ON>N(J7F748cqAi_hYQTQ8j(Ztj>W?MjMy z&pxv!)yf2WJ0Db=OmKb2nCD@F1?Znlg~hY!otPWdSH?6cp695|K`Hab&)( zsABrY)+Az(%B&A(Al{Ba5IHish+^KvkcySUE1vunND~NmlD-$oVNDdy9^;!3i29=z z0~Edl7zZU%#G+WGqm`PV_y8*fwsR;V#qupKqVL)0F~!M586%J?H46?&GqK ziHxI2Ap}<^0bZ=FPVO(@J8^htK7Y?+0i+`~dypl?Hls=brc;`Y`OE-oM8{zY4vXu|h-k#|XV24?oCFKg7RG z&hW!X&xpQ^8YjUjOrQf8#@GZ6c-Qy{U_wN|G7``B0y0#ZvE)-uuHEeup0CSI1#Z5QFwhN%tmD>M6}%#dP6dP^>NL z!^XO1POS5><3-egjd&d)?$v*sL2=`J>pj1Sw^44G3*~&v-6FqjOq=GwR1dcTN;3F5 zJj2~oW%*HlF=P&LN}nR)tsCy4+Nbej$;_=O>cF)EDG;SMi(ZAq6j|3@p>BP8+a7R(Qwq5kb4{D-mc2@;^4Jc zy!1>YuGjIke))xe^8o`=GCB1}1;o%{^%r06s|KeI%D2!#n@1XO|CGwKX_H3y9^e-P z2l28sZ4GLXs8v{v5BAgdV$15A<@5q244Xdku{g?K20t185(RDu=wr83x)#1X`XIde z9ISbhRb1IzK)uu9jwT|mXfCVZlPx&vQpv{V5=MvbxSI0y&E@o}e%9rz#>^v@3li@x dH;ok@G5Ss=kEpfC3>F?b{t`xG9Dil${{b$0yVw8# literal 0 HcmV?d00001 diff --git a/docs/reference/.doctrees/index.doctree b/docs/reference/.doctrees/index.doctree new file mode 100644 index 0000000000000000000000000000000000000000..d8769af89cb1dd00abbd6fd2f2dd0391e2d76209 GIT binary patch literal 46752 zcmeHwe~=tkeW!lyO1oOEB;y|lW4kS|HA}R!wk%6#V|0;)g+cb($i@(iZ`?c6yWOps z>7lzv(jI4WTrhZDoy#R24g!J8ugWELXTZUL4=&*dKax=83juQEjvT3if+~}OOI_uU zt1_3|=lg#3>z=ngJv(bjq;Qp2J>Bnp-+SNpdEd|be*5)%|7z@g@B7py_Fu9)>bPF} zeAR9=+CjsKddZGPQ17;!cHDciH}kIEqrFNp5!&aXpc~emUa|=(>aN#pgigEnFdj}* z`q*nmRUu$|J!oa}yJN{$?~j9U=5Fy3K}V$5zupT_)>6JGQ+x zWH?qB1hMr<9Mt2`aUQW6Ug*?g@2pepx!WJ^xf98@2b}Yyseghke5^;kpNw~GbamWw zr=mqWnY80L^q@IFg`lz3YeaxSvc2B4qX;)~J=V5c{Ax#|+ev>c+VwM`v&7O&oNqPf zqmE6G+R+J}$O+Fny>7BSwwEbK&z*FybhjoGHHnrUevL~MJ~;O#h@ffL0c zI)3h45T0Q|=a#+L?Jic)`*Wc!A4dejIs@Sx#71*m+?>~LIOnTj6!(&CO|R|rPK|XJ z-JKl$K<^Eu(90pQw`^*zUNrJm(5rhDl49J9dy63A*iuR$JZ>cM~wn?L+^wHGB2S zWQ>6h0|#R(^!RX@^4j%gx8aa2WTRw9%Rb+5I)Dmyn`v>}Ypei%#e?dZ#uelT7JR&~C0E?IbL_Rss4cOL0R|$0Gu7 zyP%ebyE&jHyG6@q&xLlU2s( zicygq5IG1ST8@5z*m3|-B~GFeTXTK-Iyt%}9`BYnlHI4BC8(=icdXZSy#{O%+4{Zx z_Z6yssSK)~&}wiwP?f8Jn^s`z_%b@hx+iFKF+N1;*_*29kCZ9;Lt4>S>Ajdt*;LeQ zix-tDn%}q7ePNEIHubhZU_o1^Phd7+w;Q?ErC3{)zvzeVy% zsWw4qzD*UagQo8bVGrUc->BSe)u^wQY1DICqwYlco1~49^Dt>U)c}&iLSkJvCY5Ac z$M(Wr@=D%^KdX zA7K~QvVECKx__I9{#c`aL5K;$bwzcf6fZ`-ghI^q@}M+KRC~$(f~v_x7rb^sH)hkA z!rIA17rb`hi5BLM#k!M;UX0q!6paW>A)AfGE*u>A2)(3I(7)NFMKzsB#^J#%JE>1K zcr1^35z6j8o{VA6>@|As3mA9)t(!M(at|c`dgS@9#-4M+8qC!(ma3hVd72wzQqo?w zf+e%rV1sVv)MjY~x{Ll1)U2!tkZtpiBa=UYKU&)!e^J^d24kt_se!AtFxlsv?_e@p zLvQfOL8G>~Qe(afyrip)Ptk3UqT~FdXkj#xj;^{8Iua(Kl#Z17&~)T4pq7vJ{QKBH z71pu-3H%T$=#Hd<8!m(jgxx8n0%fBLR6zaapQb;A@{Lo*Em>vsUX(GDF>s|+lF8A7 zpQm%L@G!h%8;Vrd%NRMV==^pfk%PpYYu?BuS$zMGP5h+EeCobL)I(9`s!7I_FM z#a*Z-ok=IZm6lLhM3rkDJ9g($(GY<_`c0Ny{O*Ka%MMp+O}o9^g~KFn+fB>@A=yz6 zqIm=tqxhf&AKvaZfGt-EIdlcZjui z9D3;XSHy@x&RYkVwhtUTXx%QGU1Pzpc}pd+4jelMUzP=6_9kO2M^AzIzc4WCdgB6g zy=}InLy9Yv^UH=|kZeBJ7Z32iNaNs2pGwk00dgEmPez2j{Lk>@pQ3+Q@GDu}P)o+ zs~p16&@M(CjWAuw|L)QpzG9R~Bc!UYSA9BLb(MwnDA_GOztj*lp>oI`(e9`YncmWm znq+gke>hGdA%^1){KJrZIa4(i-08OKaktOhY@V0p;!2fwow2-5e|gvF<@sMize|@P zF&mbuL9+iB$d`{aO3T8V;_pH}C3-8YIaP*&T-R z_3?#wW6n||XyJuXFWJ&rK|mKb;*}1lP?%SiM7V!kda@H~B6t(tl2=C*b^<;Z=j>i` zrP*ZATauM|Zm$=}S^7Dy$=mUd9snal>hHtNKK*36I-ORnWqHTB{4Gqrza9T5b#m0w zaAw5DQJd8`2PGTvB7CXcQOfloHE-MsEAQ~yT&vf{jL35)(XYbIKD`J?3ehDX`It#` z5hR6ZGbH`vT4UA#;rk6Gt_4E>J|s>-=%1#a1k$ny^xsT5%xHTOkA^}UZ~91RyTUm8 zGJ$SSKBY8O{SOobKZ_O(1;I}<75F6}_-7{3MGzFCOF;0OCecL@6r$G;!RHMnUK9v^ zkLf@A!nDw4@TQLh!F_Aa^i42)i6ON_qVbsm2Nz_+=-Bzho$J z-RNVY*9pE=rvD+p$D2M9_$JdZh6!_H?6HKJ_@xl`v_W%)2z!dPunfXJXA)h6Fd@1G z!k#mUE<%_Py?%uKjiJPgg0OEf{SSdK-t>_WHl+v0Oc>iP5=fM(-wJ12w++dp|H#@| z24{OsqKj}QM3=zXbtch8I1{4RkF%Q%C0-Pq&7vYhc^16sBjM}{ct!kGo*s5J0d7w| zr9@u;0|mi18B|+n>fXpyPzHi^ljtG{3ehDX_;!=%A_xl6>xbYk8cMt<5c~zE{~=5r zZ~BlBEKZ*6YvHwlSEJ<{cq1Vqp7@E$@hXLVHo^Ttz%C7lYjNCEwEq-~kRcX?6}pJ# z^^!>n#s-T%-eC7K0petQP~?e)5Zv)($5OZ1WFZ~@|3G{)S;Oi-s$?AX{7*o6?Dl)G zJdr&}Q&PR3K@RtTsw|rDG~Gc=UyGpA%4@7f>x;_KV$liG#xj-}y4vI9$Z=}{aj3=v zT`cmpLWiv+ZpXBAftGJWAl^fDu~dgvnqx78&ED;Z)!Td5om~y`&kX=CHT@5f21_pJTA zG^fEkw<e7C2hMAgZxJEa#Xo>=^SU$#ItA=VS~8<|Rp35}jg-lABt zwG@O}6Y^{%vmM6>kSkY3O(##`_IuoGpDu!a({_S4ETwJbSdDb0f-~b|0AT5(dM_j519HXj?PrM-zB@6 z2GT{wk-*1KJBXXHOR$5~VEqvWR6feB&#_XPl7n>{2J7Fl!J3^A<#RocG~jhH#3>ga z;^|x@|AL9i`g$f88HTTxDC@uV<;b1+-DW6d>~#|2Uc`jVZUU75|gkz2w?EK*D^*j#&(?7V-bL zp2Zl(7BBjY&lD10Io6NFivI$H`#;8?%+yq_T@cFyEMygnKt6oQECMlWj4iA1KdY-O z4RBY=xOhhmdh&~0yjzd~y#uygf^w($QyiQ{tigy%#Bja~r8dyW4@hC)1H6Dlc+k@?p8l|1p>mX7_~0rnPl_ zAKh@)JIW^2($i8O#%jwm*W$XL8O(J`_Sy`0+mH;Wi7dx!mutMHW$tG)ZD~ruVwFz= z5qUtDWUfyLRD;)_ymXjL(}{tv)C;jvboCX3ati6{%g9iUuKvm-x`?iXXd_)^-{XDX zAbQ-#3^cgJWo;Dh?2y#9f>qz zl68g=|2S2DG-A4W5Ha1Hu2q~yMe^fV?{ump583%26N*J8cOnVvpi^*_Y^{yO{nVfObU?C-y4e}9AiQfvANMAd0@0%6fS zME70{0wLKOOdwq3IthelUW-7~Q+z7U2LQXHW<)<{0A5J~xm}>|5+o3zP+AF}b$Es& zkoyhFDI}14k)a%c*e20M1R_M2AdtWyTDK)bxjUm02(NZ&0!cCDFQ6HH1abs7UrYjF zz~Kb)%P1=A<7neY63D+rB8@;~onf0_P1PTbKyDgDAUCB1@_rOol0a^wnsLvjrz%;B zKxCUhAY91$2;`$El@rLv=!y{tyBd)|RGmg45PYVjFHfV;_Ao4R)4=4_YyoRi$!mu6 zMe=gX@yR~TA<0YVCzbpvJ>i<mvm&FG_xyKr*@>7sw|aF+N@6q9vF#0Zk)@LNcrk%O!&?CvS5_GsjA z>mYKtH6@4NM{y;|;SE$X?uz`bs$?lwM79a!z=f=j9R4dx<>c^rx?<$Ou0|vWRi{zN z;a0iYYDgbsW-vXdwd(rbX=?2qOy`jy2|@`hM-i846rr;AlZ0ABFZ>MkTR9ltLbv6? zR+1>bDG-O&{>r686iOQ-dlo-3sHTuAet-<+sN%;a(M41tM3LQ|VwNn_$dPpMGf1M*g{&{=;u}=;(dgpHAi6k` z(#4?x9j^HjUl&S6CFhW92wy_B33S1QtdA~Uk5V~Zyn(J5U9hVW=|a_M6uLNOT7Eo? zTXASGZ{&+u+r#*0LlQ{85B0WyBd*yRGmiRAN8Gw_;PXBcPAzICtt+I z@lU_x;rXXuhJk;KiSTy5;H%9aqOmx8(lH}VOJya&l+{oM*^uqEU1bTvwSgE;oRBK_&+*<6~ZT!I*PwdOm(3@GFhR1X?dqtKNTWNE-cb$tJwrnZH@^5C zWPo-{>|*vQljx$aqJ-!YUqyYDS%VfXZ(knHT_POkJZsPS1CDcQd{9~lUbi}Bbv@iUBfn=l31>JG>iJISoEI!}c z4|TDh@8KVsCG2#?A_nbgQ$A^xQ2l>NtynAMP|1FW_No)EQ$J&Qv~LF)8ViICQVwxG z90(hKK-k!^q3uL!M~`8$C@fS4U?H6s{v;3;lzamkB$WK;ec$?3{BLOYlG)?oax_1w z47t9;08Jv~Rvna}Dz=XB|EDftj7gA`Abu(39xI_-u~Ebksy5#!Vjh>^gdb?-7&eDU zZY)=AS+}yuRpsw3QF-yPh^Rb$0)IEFeAb}qwuSH{KAhKb@g}DuIUkdxT;judO;Ja= zqB322>NGcxYy*}ic3lZ^Y$`?(ZGuufjt*KU?Play0g{I2yht2$TFG|!4k=&iHNBxU z*D9g8Y`2d?a~^Napl-i|Z2bnb3-hy$5TzRZ&JvBz!eu)e{SMaXVc`jlrLfC9ooSiz6ZpqZ{{dCy9`Ntc74v}E)x~xm zk70!wJN~W4kE5xb!(p>Tg>Ff|ajli>YswwjWqjkBqALLo(DmAOQ#3}LRnow*CgKuf zO*JyWpoSuQ-s};DMdr*;~w)^BwUz>Sy zF6Xy-|7MP@m{2y&1iEeXR3eT4P-?r)pteGI9cIld6VW(n5?ur@A-V*-9x#b6if9PY z>xb8pp~Q;;^cktGc&3GKSWLJyo|16kdqrzohgDf5{+cJeK`YFR@SFbtAtIX(;GC2W*tM(aW zFB>WQH?I>eNrX@tUR&W{DW_p^_rzLU!A7{PMQpc;ZEGm?J-Em5OvY{b`k%m7; zhH_!kZyQ|+u=~W%7Pp%(qXxF*8=Vhp7KG3aK zQ+9xeRv2}ecAx(NbkIgcEB*koc(mdeD(TZt8LhZ1Zxypa3Te79S@|Gxl?_rHyBnm; z!w16SII=V74;avJsC@FSeu!`7Zi4`oy_3PP_P03j_1a7l6*)PEdJDC_&bn*08W z8FVjRU+5$HMmv*7%rb^p^z+sdsuhmJX=(yr^z$GtOE}wyhHrwz&U&&cyqqb~DB(JY zMo|R8WsS<(Y~2EAi-ELUToviaFK{O{1>VmUm~kinlX55TQ0F}0q@y+>G*L_k0?E^g z(#QIlTC_zu4!4&lY6)~J6;)PU$ zvv$*KXvaU9kd`hk5{uH)8>(woOLR>ZZ?qWZF|Mvbj_Yrynz^(U2N(G#qOPjjK3JmL zvLlLCKE0oH+b|=Fa`Da{W<(K0XhaR+jB8^tHO<9k3TIpr>H3}VFQBU28UG?(F=w1z zZGP(NpH7JwB!u8G>MK7pL2)Ak%q zVETw1#7B>EVz+8z;BsB8tdz`DWfRYgrDRDC#|mV^7B7 zAhw&mQ}{|#rg0kh*`+bJIhhvkZE8Z+LNX=q(1QBjLb5}0d@tEcSdHcbulf?(nsn^`;#~Xbj2|8Pts_94Z=wajof`b)e2I z$)t;eyyVZZWUq7Hi)(0I+>O$^V-07qy9{~L=j@OsPe>6ub_;hV&>eM$nnd;U+R$0e zY1i@276-m06Ww@e_O@AeX6wtd4{J^s1|im&wi`_+L=R9^>v1pH%{8w{8Dmm<$u+qr zIT8NRX;|`UE;p@%%>DB0gIwlh548c|%9q@{-W0 z2VtYua5_K_it?DY$GHPYTJahZ6gX;j8mCtVwe(i9#RKGaHM*@%O~De%Wj8z^GQb~9V4g)+PAidRzoNgnioo^AS_BiJ|LFCl*oD3=TxOUcqd1kQPU2Axey@>BbRV}y6 z;ew$zg~miUrH73@2;C);)yP?mdN3kavX2um&2~aIKAkp6YoObAhW0sh7yo%`bF!Dl z9MIEV#zNwz*Ye`tJ$nu$(;cT%Q#OSfGevh6@!q~h!y|dA8^@h!er^u8qiTmKyBdVc z7*$tLN>%}+tVtW!!zW-)XZD7h4nv>Q;Zi*(p6;aLZbwu zH*Pgi*hFkEVk9+iT*Ijy$u+=btEL91YCtXO5K2~)J<$qy?|jYmmfa@)2Zpyb1A_ll z)WUhfoI4{Z>Lu(qqf(5npl%D*UQ>5*9B>^S&&M3PlBp26&vZK|Vj8uJy%?RxO~ESA z6V$!-5-=ca!)0VFqV8fYnb)$H(H96+umOof$Y7QLnbxAyz$nI1s*&qBIF32FqK;H& zYEBDFAZm7_LADn?|9G;OB$GvsoaPd@Ypcmtr+v1EZ^4rt+@fFz1Bp08%EQ=*YnTTt zJFrl|&0bUr$ckZdAp_fBlSNN1%iN`No7ingTT(y9$*eXQ0k|(b++!0Wn@y4MgCpbJ&7EvEp~4TEQrT>tg&#E2vb#9n3MEKc?{(kpPr_FC+wsSJ+Wn~e757j4cOs?# z4*K&Pc-H?4{n1pqAnhD&BtavB! z#D;DR#TPe3a{yxpP^1w!50sHz#!4F;@T>d7B5_qFX0IbK_kE7L7nr`%m*9Lp%dXfQ zmtC=WFS}yXY<9)8&8}!VUZff}UoWMdcW$V5*oP7G>?PH@*FQ&Dnl^aMW9kDm|)N570Mis9kW5#*lNq?sQ1i);YLL zp^Y!n8uOD6$QhJXX$4UX*QriRkiZU29M?@Jc~4r_N%~-PzZubYdyAnRuFRdV>#h^c zbyhlogOmH_&U#_o1;@0{Msr&AW*-b+`=E2Sb8@z`a!d8*TjrYHA~Mm`hW*5h!I=fO zogrn-MIF~`pRb`g^)qwM`55Tme~^8qY8^g&_#nl;7`ealb#>nEhYl+*kyxOPC4f;-Ju`kzEn7M$4C1Xe?Q?Ztu=+89pW zP_0@Fv-9-bSGt*{0Lna`5me{N%gm%;cOy4AH;WIkV;Y|_Vz7}SRjdDWK&#~&wJ#$b ze12*M`NnZB4eZ<35wIJ5Qg!7lx2#e@^dIRr9%NHt`82+kGZ=*)g%RlgpIj zA&n%N&WisGl4s{FnV5~3%Ir<@zESW?! zzfn#1JNiD#EeVkCB56@HC6OxHELF7a^$REOB`=f*Bm6sH@1?#rOC{lLPT9uaHB{pn zisJ$8-@LnY`~P9s_WLg&N80*(E@ .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/reference/_static/basic.css b/docs/reference/_static/basic.css new file mode 100644 index 0000000..d9846da --- /dev/null +++ b/docs/reference/_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/reference/_static/custom.css b/docs/reference/_static/custom.css new file mode 100644 index 0000000..2a924f1 --- /dev/null +++ b/docs/reference/_static/custom.css @@ -0,0 +1 @@ +/* This file intentionally left blank. */ diff --git a/docs/reference/_static/doctools.js b/docs/reference/_static/doctools.js new file mode 100644 index 0000000..0398ebb --- /dev/null +++ b/docs/reference/_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/reference/_static/documentation_options.js b/docs/reference/_static/documentation_options.js new file mode 100644 index 0000000..2027f55 --- /dev/null +++ b/docs/reference/_static/documentation_options.js @@ -0,0 +1,13 @@ +const DOCUMENTATION_OPTIONS = { + VERSION: 'MIT', + LANGUAGE: 'Python', + 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/reference/_static/file.png b/docs/reference/_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/reference/_static/github-banner.svg b/docs/reference/_static/github-banner.svg new file mode 100644 index 0000000..c47d9dc --- /dev/null +++ b/docs/reference/_static/github-banner.svg @@ -0,0 +1,5 @@ + + + + + diff --git a/docs/reference/_static/language_data.js b/docs/reference/_static/language_data.js new file mode 100644 index 0000000..c7fe6c6 --- /dev/null +++ b/docs/reference/_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/reference/_static/minus.png b/docs/reference/_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/reference/_static/plus.png b/docs/reference/_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/reference/_static/pygments.css b/docs/reference/_static/pygments.css new file mode 100644 index 0000000..04a4174 --- /dev/null +++ b/docs/reference/_static/pygments.css @@ -0,0 +1,84 @@ +pre { line-height: 125%; } +td.linenos .normal { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; } +span.linenos { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; } +td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } +span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } +.highlight .hll { background-color: #ffffcc } +.highlight { background: #f8f8f8; } +.highlight .c { color: #8f5902; font-style: italic } /* Comment */ +.highlight .err { color: #a40000; border: 1px solid #ef2929 } /* Error */ +.highlight .g { color: #000000 } /* Generic */ +.highlight .k { color: #004461; font-weight: bold } /* Keyword */ +.highlight .l { color: #000000 } /* Literal */ +.highlight .n { color: #000000 } /* Name */ +.highlight .o { color: #582800 } /* Operator */ +.highlight .x { color: #000000 } /* Other */ +.highlight .p { color: #000000; font-weight: bold } /* Punctuation */ +.highlight .ch { color: #8f5902; font-style: italic } /* Comment.Hashbang */ +.highlight .cm { color: #8f5902; font-style: italic } /* Comment.Multiline */ +.highlight .cp { color: #8f5902 } /* Comment.Preproc */ +.highlight .cpf { color: #8f5902; font-style: italic } /* Comment.PreprocFile */ +.highlight .c1 { color: #8f5902; font-style: italic } /* Comment.Single */ +.highlight .cs { color: #8f5902; font-style: italic } /* Comment.Special */ +.highlight .gd { color: #a40000 } /* Generic.Deleted */ +.highlight .ge { color: #000000; font-style: italic } /* Generic.Emph */ +.highlight .ges { color: #000000 } /* Generic.EmphStrong */ +.highlight .gr { color: #ef2929 } /* Generic.Error */ +.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */ +.highlight .gi { color: #00A000 } /* Generic.Inserted */ +.highlight .go { color: #888888 } /* Generic.Output */ +.highlight .gp { color: #745334 } /* Generic.Prompt */ +.highlight .gs { color: #000000; font-weight: bold } /* Generic.Strong */ +.highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */ +.highlight .gt { color: #a40000; font-weight: bold } /* Generic.Traceback */ +.highlight .kc { color: #004461; font-weight: bold } /* Keyword.Constant */ +.highlight .kd { color: #004461; font-weight: bold } /* Keyword.Declaration */ +.highlight .kn { color: #004461; font-weight: bold } /* Keyword.Namespace */ +.highlight .kp { color: #004461; font-weight: bold } /* Keyword.Pseudo */ +.highlight .kr { color: #004461; font-weight: bold } /* Keyword.Reserved */ +.highlight .kt { color: #004461; font-weight: bold } /* Keyword.Type */ +.highlight .ld { color: #000000 } /* Literal.Date */ +.highlight .m { color: #990000 } /* Literal.Number */ +.highlight .s { color: #4e9a06 } /* Literal.String */ +.highlight .na { color: #c4a000 } /* Name.Attribute */ +.highlight .nb { color: #004461 } /* Name.Builtin */ +.highlight .nc { color: #000000 } /* Name.Class */ +.highlight .no { color: #000000 } /* Name.Constant */ +.highlight .nd { color: #888888 } /* Name.Decorator */ +.highlight .ni { color: #ce5c00 } /* Name.Entity */ +.highlight .ne { color: #cc0000; font-weight: bold } /* Name.Exception */ +.highlight .nf { color: #000000 } /* Name.Function */ +.highlight .nl { color: #f57900 } /* Name.Label */ +.highlight .nn { color: #000000 } /* Name.Namespace */ +.highlight .nx { color: #000000 } /* Name.Other */ +.highlight .py { color: #000000 } /* Name.Property */ +.highlight .nt { color: #004461; font-weight: bold } /* Name.Tag */ +.highlight .nv { color: #000000 } /* Name.Variable */ +.highlight .ow { color: #004461; font-weight: bold } /* Operator.Word */ +.highlight .pm { color: #000000; font-weight: bold } /* Punctuation.Marker */ +.highlight .w { color: #f8f8f8 } /* Text.Whitespace */ +.highlight .mb { color: #990000 } /* Literal.Number.Bin */ +.highlight .mf { color: #990000 } /* Literal.Number.Float */ +.highlight .mh { color: #990000 } /* Literal.Number.Hex */ +.highlight .mi { color: #990000 } /* Literal.Number.Integer */ +.highlight .mo { color: #990000 } /* Literal.Number.Oct */ +.highlight .sa { color: #4e9a06 } /* Literal.String.Affix */ +.highlight .sb { color: #4e9a06 } /* Literal.String.Backtick */ +.highlight .sc { color: #4e9a06 } /* Literal.String.Char */ +.highlight .dl { color: #4e9a06 } /* Literal.String.Delimiter */ +.highlight .sd { color: #8f5902; font-style: italic } /* Literal.String.Doc */ +.highlight .s2 { color: #4e9a06 } /* Literal.String.Double */ +.highlight .se { color: #4e9a06 } /* Literal.String.Escape */ +.highlight .sh { color: #4e9a06 } /* Literal.String.Heredoc */ +.highlight .si { color: #4e9a06 } /* Literal.String.Interpol */ +.highlight .sx { color: #4e9a06 } /* Literal.String.Other */ +.highlight .sr { color: #4e9a06 } /* Literal.String.Regex */ +.highlight .s1 { color: #4e9a06 } /* Literal.String.Single */ +.highlight .ss { color: #4e9a06 } /* Literal.String.Symbol */ +.highlight .bp { color: #3465a4 } /* Name.Builtin.Pseudo */ +.highlight .fm { color: #000000 } /* Name.Function.Magic */ +.highlight .vc { color: #000000 } /* Name.Variable.Class */ +.highlight .vg { color: #000000 } /* Name.Variable.Global */ +.highlight .vi { color: #000000 } /* Name.Variable.Instance */ +.highlight .vm { color: #000000 } /* Name.Variable.Magic */ +.highlight .il { color: #990000 } /* Literal.Number.Integer.Long */ \ No newline at end of file diff --git a/docs/reference/_static/searchtools.js b/docs/reference/_static/searchtools.js new file mode 100644 index 0000000..2c774d1 --- /dev/null +++ b/docs/reference/_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/reference/_static/sphinx_highlight.js b/docs/reference/_static/sphinx_highlight.js new file mode 100644 index 0000000..8a96c69 --- /dev/null +++ b/docs/reference/_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/reference/genindex.html b/docs/reference/genindex.html new file mode 100644 index 0000000..3ba4bb9 --- /dev/null +++ b/docs/reference/genindex.html @@ -0,0 +1,269 @@ + + + + + + + Index — StoryCraftr MIT documentation + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ + +

Index

+ +
+ A + | B + | D + | F + | G + | L + | M + | P + | R + | S + +
+

A

+ + +
+ +

B

+ + + +
+ +

D

+ + +
+ +

F

+ + +
+ +

G

+ + + +
+ +

L

+ + + +
+ +

M

+ + +
+ +

P

+ + +
+ +

R

+ + +
+ +

S

+ + + +
    +
  • + storycraftr.prompts.chapters + +
    • +
  • + storycraftr.prompts.core + +
    • +
  • + storycraftr.prompts.iterate + +
    • +
  • + storycraftr.prompts.outline + +
    • +
    +
  • + storycraftr.prompts.permute + +
    • +
  • + storycraftr.prompts.worldbuilding + +
    • +
  • + storycraftr.utils.core + +
    • +
+ + + +
+ +
+
+ +
+
+
+ ©2024, Rodrigo Estrada. + + | + Powered by Sphinx 8.1.3 + & Alabaster 1.0.0 + +
+ + + + + + \ No newline at end of file diff --git a/docs/reference/index.html b/docs/reference/index.html new file mode 100644 index 0000000..c335d2c --- /dev/null +++ b/docs/reference/index.html @@ -0,0 +1,228 @@ + + + + + + + + Welcome to StoryCraftr's documentation! — StoryCraftr MIT documentation + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

Welcome to StoryCraftr's documentation!

+
+
+
+
+

Reference Guide

+
+

Agent Module

+
+
+

Command Module

+
+
+

Prompts Module

+
+
+

Utils Module

+
+
+class storycraftr.utils.core.BookConfig(book_path: str, book_name: str, primary_language: str, alternate_languages: list, default_author: str, genre: str, license: str, reference_author: str)
+

A NamedTuple representing the configuration of a book.

+
+
Attributes:

book_path (str): The path to the book's directory. +book_name (str): The name of the book. +primary_language (str): The primary language of the book. +alternate_languages (list): A list of alternate languages. +default_author (str): The default author of the book. +genre (str): The genre of the book. +license (str): The license type for the book. +reference_author (str): A reference author for style guidance.

+
+
+
+
+alternate_languages: list
+

Alias for field number 3

+
+ +
+
+book_name: str
+

Alias for field number 1

+
+ +
+
+book_path: str
+

Alias for field number 0

+
+ +
+
+default_author: str
+

Alias for field number 4

+
+ +
+
+genre: str
+

Alias for field number 5

+
+ +
+
+license: str
+

Alias for field number 6

+
+ +
+
+primary_language: str
+

Alias for field number 2

+
+ +
+
+reference_author: str
+

Alias for field number 7

+
+ +
+ +
+
+storycraftr.utils.core.file_has_more_than_three_lines(file_path: str) → bool
+

Check if a file has more than three lines.

+
+
Args:

file_path (str): The path to the file.

+
+
Returns:

bool: True if the file has more than three lines, False otherwise.

+
+
+
+ +
+
+storycraftr.utils.core.generate_prompt_with_hash(original_prompt: str, date: str, book_path: str) → str
+

Generates a modified prompt by combining a random phrase from a list, +a date, and the original prompt. Logs the prompt details in a YAML file.

+
+
Args:

original_prompt (str): The original prompt to be modified. +date (str): The current date to be used in the prompt. +book_path (str): Path to the book's directory where prompts.yaml will be saved.

+
+
Returns:

str: The modified prompt with the date and random phrase.

+
+
+
+ +
+
+storycraftr.utils.core.load_book_config(book_path: str) → BookConfig
+

Loads the book's configuration from the storycraftr.json file.

+
+
Args:

book_path (str): The path to the book's directory.

+
+
Returns:

BookConfig: An instance of the BookConfig NamedTuple containing the book's settings. +None: If the storycraftr.json file is not found or is in an invalid directory.

+
+
+
+ +
+
+

Templates

+
+

(Si necesitas documentar algo relacionado con templates, puedes añadirlo aquí.)

+
+
+
+ + +
+ +
+
+ +
+
+
+ ©2024, Rodrigo Estrada. + + | + Powered by Sphinx 8.1.3 + & Alabaster 1.0.0 + + | + Page source +
+ + + + + + \ No newline at end of file diff --git a/docs/reference/objects.inv b/docs/reference/objects.inv new file mode 100644 index 0000000..1772a85 --- /dev/null +++ b/docs/reference/objects.inv @@ -0,0 +1,7 @@ +# Sphinx inventory version 2 +# Project: StoryCraftr +# Version: +# The remainder of this file is compressed using zlib. +xڭT=k0+TZӬC!8gKTD_&_b{IS2RiE7E"ɶz"ނ{™Pe}bk\t@l'[Wڸ3|s]cFqe!F [p҂k8v0Q:^Tcɲb-5 +]\t@ $t +1('Yjyh6kSl2}\rCy0 =zc4I?d"" ZZuoñ8^ Ahϣ^[m[=GCSaP(1ѽOcҽHkd0ɿ V|K \ No newline at end of file diff --git a/docs/reference/py-modindex.html b/docs/reference/py-modindex.html new file mode 100644 index 0000000..8cf69b2 --- /dev/null +++ b/docs/reference/py-modindex.html @@ -0,0 +1,149 @@ + + + + + + + Python Module Index — StoryCraftr MIT documentation + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ + +

Python Module Index

+ +
+ s +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
 
+ s
+ storycraftr +
    + storycraftr.prompts.chapters +
    + storycraftr.prompts.core +
    + storycraftr.prompts.iterate +
    + storycraftr.prompts.outline +
    + storycraftr.prompts.permute +
    + storycraftr.prompts.worldbuilding +
    + storycraftr.utils.core +
+ + +
+ +
+
+ +
+
+
+ ©2024, Rodrigo Estrada. + + | + Powered by Sphinx 8.1.3 + & Alabaster 1.0.0 + +
+ + + + + + \ No newline at end of file diff --git a/docs/reference/search.html b/docs/reference/search.html new file mode 100644 index 0000000..3ecd5c0 --- /dev/null +++ b/docs/reference/search.html @@ -0,0 +1,117 @@ + + + + + + + Search — StoryCraftr MIT documentation + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +

Search

+ + + + +

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

+ + +
+ + + +
+ + +
+ + +
+ +
+
+ +
+
+
+ ©2024, Rodrigo Estrada. + + | + Powered by Sphinx 8.1.3 + & Alabaster 1.0.0 + +
+ + + + + + \ No newline at end of file diff --git a/docs/reference/searchindex.js b/docs/reference/searchindex.js new file mode 100644 index 0000000..c841584 --- /dev/null +++ b/docs/reference/searchindex.js @@ -0,0 +1 @@ +Search.setIndex({"alltitles": {"Agent Module": [[0, "agent-module"]], "Command Module": [[0, "command-module"]], "Prompts Module": [[0, "module-storycraftr.prompts.chapters"]], "Reference Guide": [[0, "reference-guide"]], "Templates": [[0, "templates"]], "Utils Module": [[0, "module-storycraftr.utils.core"]], "Welcome to StoryCraftr's documentation!": [[0, null]]}, "docnames": ["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": ["index.rst"], "indexentries": {"alternate_languages (storycraftr.utils.core.bookconfig attribute)": [[0, "storycraftr.utils.core.BookConfig.alternate_languages", false]], "book_name (storycraftr.utils.core.bookconfig attribute)": [[0, "storycraftr.utils.core.BookConfig.book_name", false]], "book_path (storycraftr.utils.core.bookconfig attribute)": [[0, "storycraftr.utils.core.BookConfig.book_path", false]], "bookconfig (class in storycraftr.utils.core)": [[0, "storycraftr.utils.core.BookConfig", false]], "default_author (storycraftr.utils.core.bookconfig attribute)": [[0, "storycraftr.utils.core.BookConfig.default_author", false]], "file_has_more_than_three_lines() (in module storycraftr.utils.core)": [[0, "storycraftr.utils.core.file_has_more_than_three_lines", false]], "generate_prompt_with_hash() (in module storycraftr.utils.core)": [[0, "storycraftr.utils.core.generate_prompt_with_hash", false]], "genre (storycraftr.utils.core.bookconfig attribute)": [[0, "storycraftr.utils.core.BookConfig.genre", false]], "license (storycraftr.utils.core.bookconfig attribute)": [[0, "storycraftr.utils.core.BookConfig.license", false]], "load_book_config() (in module storycraftr.utils.core)": [[0, "storycraftr.utils.core.load_book_config", false]], "module": [[0, "module-storycraftr.prompts.chapters", false], [0, "module-storycraftr.prompts.core", false], [0, "module-storycraftr.prompts.iterate", false], [0, "module-storycraftr.prompts.outline", false], [0, "module-storycraftr.prompts.permute", false], [0, "module-storycraftr.prompts.worldbuilding", false], [0, "module-storycraftr.utils.core", false]], "primary_language (storycraftr.utils.core.bookconfig attribute)": [[0, "storycraftr.utils.core.BookConfig.primary_language", false]], "reference_author (storycraftr.utils.core.bookconfig attribute)": [[0, "storycraftr.utils.core.BookConfig.reference_author", false]], "storycraftr.prompts.chapters": [[0, "module-storycraftr.prompts.chapters", false]], "storycraftr.prompts.core": [[0, "module-storycraftr.prompts.core", false]], "storycraftr.prompts.iterate": [[0, "module-storycraftr.prompts.iterate", false]], "storycraftr.prompts.outline": [[0, "module-storycraftr.prompts.outline", false]], "storycraftr.prompts.permute": [[0, "module-storycraftr.prompts.permute", false]], "storycraftr.prompts.worldbuilding": [[0, "module-storycraftr.prompts.worldbuilding", false]], "storycraftr.utils.core": [[0, "module-storycraftr.utils.core", false]]}, "objects": {"storycraftr.prompts": [[0, 0, 0, "-", "chapters"], [0, 0, 0, "-", "core"], [0, 0, 0, "-", "iterate"], [0, 0, 0, "-", "outline"], [0, 0, 0, "-", "permute"], [0, 0, 0, "-", "worldbuilding"]], "storycraftr.utils": [[0, 0, 0, "-", "core"]], "storycraftr.utils.core": [[0, 1, 1, "", "BookConfig"], [0, 3, 1, "", "file_has_more_than_three_lines"], [0, 3, 1, "", "generate_prompt_with_hash"], [0, 3, 1, "", "load_book_config"]], "storycraftr.utils.core.BookConfig": [[0, 2, 1, "", "alternate_languages"], [0, 2, 1, "", "book_name"], [0, 2, 1, "", "book_path"], [0, 2, 1, "", "default_author"], [0, 2, 1, "", "genre"], [0, 2, 1, "", "license"], [0, 2, 1, "", "primary_language"], [0, 2, 1, "", "reference_author"]]}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "attribute", "Python attribute"], "3": ["py", "function", "Python function"]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:attribute", "3": "py:function"}, "terms": {"0": 0, "1": 0, "2": 0, "3": 0, "4": 0, "5": 0, "6": 0, "7": 0, "A": 0, "If": 0, "The": 0, "across": [], "adjust": [], "agent": [], "ai": [], "algo": 0, "alia": 0, "all": [], "allow": [], "altern": 0, "alternate_languag": 0, "an": 0, "aqu\u00ed": 0, "arg": 0, "aspect": [], "assist": [], "attribut": 0, "author": 0, "a\u00f1adirlo": 0, "befor": [], "behavior": [], "between": [], "book": 0, "book_nam": 0, "book_path": 0, "bookconfig": 0, "bool": 0, "chang": [], "chapter_numb": [], "character_nam": [], "check": 0, "class": 0, "cli": [], "combin": 0, "comma": [], "command": [], "con": 0, "configur": 0, "contain": 0, "content": [], "context": [], "core": 0, "current": 0, "custom": [], "date": 0, "debug": [], "default": 0, "default_author": 0, "defin": [], "detail": 0, "directori": 0, "documentar": 0, "dynam": [], "enabl": [], "execut": [], "exist": [], "fals": 0, "field": 0, "file": 0, "file_has_more_than_three_lin": 0, "file_path": 0, "format": [], "found": 0, "from": 0, "function": [], "futur": [], "gener": 0, "generate_prompt_with_hash": 0, "genr": 0, "given": [], "group": [], "guidanc": 0, "ha": 0, "i": 0, "includ": [], "initi": [], "instanc": 0, "int": [], "interact": [], "invalid": 0, "json": 0, "languag": 0, "licens": 0, "line": 0, "list": 0, "load": 0, "load_book_config": 0, "log": 0, "main": [], "manag": [], "mode": [], "modifi": 0, "modul": [], "more": 0, "name": 0, "namedtupl": 0, "necesita": 0, "need": [], "new": [], "new_nam": [], "none": 0, "number": 0, "one": [], "option": [], "origin": 0, "original_nam": [], "original_prompt": 0, "other": [], "otherwis": 0, "overal": [], "path": 0, "phrase": 0, "posit": [], "primari": 0, "primary_languag": 0, "prompt": [], "provid": [], "pued": 0, "random": 0, "reference_author": 0, "relacionado": 0, "renam": [], "replac": [], "repres": 0, "requir": [], "return": 0, "save": 0, "scene": [], "scienc": [], "separ": [], "session": [], "set": 0, "shift": [], "si": 0, "specifi": [], "start": [], "stori": [], "story_context": [], "str": 0, "structur": [], "style": 0, "subsequ": [], "synops": [], "than": 0, "thi": [], "three": 0, "tool": [], "translat": [], "true": 0, "two": [], "type": 0, "us": 0, "variou": [], "version": [], "where": 0, "within": [], "work": [], "write": [], "yaml": 0, "your": []}, "titles": ["Welcome to StoryCraftr's documentation!"], "titleterms": {"": 0, "add": [], "agent": 0, "argument": [], "back": [], "chapter": [], "charact": [], "chat": [], "check": [], "command": 0, "consist": [], "cover": [], "cultur": [], "document": 0, "epilogu": [], "fix": [], "flashback": [], "gener": [], "geographi": [], "guid": 0, "histori": [], "init": [], "insert": [], "iter": [], "magic": [], "modul": 0, "motiv": [], "name": [], "outlin": [], "pdf": [], "plot": [], "point": [], "prompt": 0, "publish": [], "refer": 0, "refin": [], "split": [], "storycraftr": 0, "strengthen": [], "summari": [], "synopsi": [], "system": [], "technologi": [], "templat": 0, "util": 0, "welcom": 0, "worldbuild": []}}) \ No newline at end of file diff --git a/docs/source/conf.py b/docs/source/conf.py new file mode 100644 index 0000000..20908f3 --- /dev/null +++ b/docs/source/conf.py @@ -0,0 +1,37 @@ +# Configuration file for the Sphinx documentation builder. +# +# For the full list of built-in configuration values, see the documentation: +# https://www.sphinx-doc.org/en/master/usage/configuration.html + +# -- Project information ----------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information + +project = "StoryCraftr" +copyright = "2024, Rodrigo Estrada" +author = "Rodrigo Estrada" +release = "MIT" + +# -- General configuration --------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration + +extensions = [] + +templates_path = ["_templates"] +exclude_patterns = [] + +language = "Python" + +# -- Options for HTML output ------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output + +html_theme = "alabaster" +html_static_path = ["_static"] + +# Añadir estas líneas al final de conf.py +extensions = [ + "sphinx.ext.autodoc", + "sphinx_click.ext", +] + +# Opcionalmente, si quieres usar un tema como 'alabaster' o 'readthedocs' +html_theme = "alabaster" diff --git a/docs/source/index.rst b/docs/source/index.rst new file mode 100644 index 0000000..33f02b7 --- /dev/null +++ b/docs/source/index.rst @@ -0,0 +1,111 @@ +.. StoryCraftr documentation master file, created by + sphinx-quickstart on Tue Oct 22 14:46:11 2024. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +.. StoryCraftr documentation master file + +.. StoryCraftr documentation master file + +Welcome to StoryCraftr's documentation! +======================================== + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + modules + +Reference Guide +=============== + +Agent Module +------------ + +.. automodule:: storycraftr.agent.agents + :members: + +.. automodule:: storycraftr.agent.chapters + :members: + +.. automodule:: storycraftr.agent.iterate + :members: + +.. automodule:: storycraftr.agent.outline + :members: + +.. automodule:: storycraftr.agent.retrieval + :members: + +.. automodule:: storycraftr.agent.worldbuilding + :members: + +Command Module +-------------- + +.. click:: storycraftr.cmd.cli:cli + :prog: storycraftr + :show-nested: + +.. automodule:: storycraftr.cmd.chapters + :members: + +.. automodule:: storycraftr.cmd.chat + :members: + +.. automodule:: storycraftr.cmd.iterate + :members: + +.. automodule:: storycraftr.cmd.outline + :members: + +.. automodule:: storycraftr.cmd.publish + :members: + +.. automodule:: storycraftr.cmd.worldbuilding + :members: + +Prompts Module +-------------- + +.. automodule:: storycraftr.prompts.chapters + :members: + +.. automodule:: storycraftr.prompts.core + :members: + +.. automodule:: storycraftr.prompts.iterate + :members: + +.. automodule:: storycraftr.prompts.outline + :members: + +.. automodule:: storycraftr.prompts.permute + :members: + +.. automodule:: storycraftr.prompts.worldbuilding + :members: + +Utils Module +------------ + +.. automodule:: storycraftr.utils.core + :members: + +.. automodule:: storycraftr.utils.markdown + :members: + +.. automodule:: storycraftr.utils.pdf + :members: + +.. automodule:: storycraftr.utils.cli + :members: + +.. automodule:: storycraftr.utils.state + :members: + +Templates +--------- + + (Si necesitas documentar algo relacionado con templates, puedes añadirlo aquí.) + diff --git a/examples/example_usage.sh b/examples/example_usage.sh index a1ea84c..463ab78 100644 --- a/examples/example_usage.sh +++ b/examples/example_usage.sh @@ -12,7 +12,9 @@ while [[ "$#" -gt 0 ]]; do done # Ejecuta los comandos con la variable COMMAND, que puede ser 'poetry run storycraftr' o 'storycraftr' -$COMMAND init "The Purge of the gods" --primary-language "en" --alternate-languages "es" --author "Rodrigo Estrada" --genre "science fiction" --behavior "behavior.txt" --reference-author="Brandon Sanderson" +$COMMAND init "La Purga de los dioses" --primary-language "es" --alternate-languages "en" --author "Rodrigo Estrada" --genre "science fiction" --behavior "behavior.txt" --reference-author="Brandon Sanderson" + +cd "La Purga de los dioses" $COMMAND outline general-outline "Summarize the overall plot of a dystopian science fiction where advanced technology, resembling magic, has led to the fall of humanity’s elite and the rise of a manipulative villain who seeks to destroy both the ruling class and the workers." diff --git a/poetry.lock b/poetry.lock index ab0b5cf..5048c40 100644 --- a/poetry.lock +++ b/poetry.lock @@ -1,5 +1,16 @@ # This file is automatically @generated by Poetry 1.8.4 and should not be changed by hand. +[[package]] +name = "alabaster" +version = "1.0.0" +description = "A light, configurable Sphinx theme" +optional = false +python-versions = ">=3.10" +files = [ + {file = "alabaster-1.0.0-py3-none-any.whl", hash = "sha256:fc6786402dc3fcb2de3cabd5fe455a2db534b371124f1f21de8731783dec828b"}, + {file = "alabaster-1.0.0.tar.gz", hash = "sha256:c00dca57bca26fa62a6d7d0a9fcce65f3e026e9bfe33e9c538fd3fbb2144fd9e"}, +] + [[package]] name = "annotated-types" version = "0.7.0" @@ -80,6 +91,20 @@ docs = ["cogapp", "furo", "myst-parser", "sphinx", "sphinx-notfound-page", "sphi tests = ["cloudpickle", "hypothesis", "mypy (>=1.11.1)", "pympler", "pytest (>=4.3.0)", "pytest-mypy-plugins", "pytest-xdist[psutil]"] tests-mypy = ["mypy (>=1.11.1)", "pytest-mypy-plugins"] +[[package]] +name = "babel" +version = "2.16.0" +description = "Internationalization utilities" +optional = false +python-versions = ">=3.8" +files = [ + {file = "babel-2.16.0-py3-none-any.whl", hash = "sha256:368b5b98b37c06b7daf6696391c3240c938b37767d4584413e8438c5c435fa8b"}, + {file = "babel-2.16.0.tar.gz", hash = "sha256:d1f3554ca26605fe173f3de0c65f750f5a42f924499bf134de6423582298e316"}, +] + +[package.extras] +dev = ["freezegun (>=1.0,<2.0)", "pytest (>=6.0)", "pytest-cov"] + [[package]] name = "black" version = "24.10.0" @@ -320,6 +345,17 @@ files = [ {file = "distro-1.9.0.tar.gz", hash = "sha256:2fa77c6fd8940f116ee1d6b94a2f90b13b5ea8d019b98bc8bafdcabcdd9bdbed"}, ] +[[package]] +name = "docutils" +version = "0.21.2" +description = "Docutils -- Python Documentation Utilities" +optional = false +python-versions = ">=3.9" +files = [ + {file = "docutils-0.21.2-py3-none-any.whl", hash = "sha256:dafca5b9e384f0e419294eb4d2ff9fa826435bf15f15b7bd45723e8ad76811b2"}, + {file = "docutils-0.21.2.tar.gz", hash = "sha256:3a6b18732edf182daa3cd12775bbb338cf5691468f91eeeb109deff6ebfa986f"}, +] + [[package]] name = "exceptiongroup" version = "1.2.2" @@ -450,28 +486,16 @@ files = [ all = ["flake8 (>=7.1.1)", "mypy (>=1.11.2)", "pytest (>=8.3.2)", "ruff (>=0.6.2)"] [[package]] -name = "importlib-metadata" -version = "8.5.0" -description = "Read metadata from Python packages" +name = "imagesize" +version = "1.4.1" +description = "Getting image size from png/jpeg/jpeg2000/gif file" optional = false -python-versions = ">=3.8" +python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*" files = [ - {file = "importlib_metadata-8.5.0-py3-none-any.whl", hash = "sha256:45e54197d28b7a7f1559e60b95e7c567032b602131fbd588f1497f47880aa68b"}, - {file = "importlib_metadata-8.5.0.tar.gz", hash = "sha256:71522656f0abace1d072b9e5481a48f07c138e00f079c38c8f883823f9c26bd7"}, + {file = "imagesize-1.4.1-py2.py3-none-any.whl", hash = "sha256:0d8d18d08f840c19d0ee7ca1fd82490fdc3729b7ac93f49870406ddde8ef8d8b"}, + {file = "imagesize-1.4.1.tar.gz", hash = "sha256:69150444affb9cb0d5cc5a92b3676f0b2fb7cd9ae39e947a5e11a36b4497cd4a"}, ] -[package.dependencies] -zipp = ">=3.20" - -[package.extras] -check = ["pytest-checkdocs (>=2.4)", "pytest-ruff (>=0.2.1)"] -cover = ["pytest-cov"] -doc = ["furo", "jaraco.packaging (>=9.3)", "jaraco.tidelift (>=1.4)", "rst.linker (>=1.9)", "sphinx (>=3.5)", "sphinx-lint"] -enabler = ["pytest-enabler (>=2.2)"] -perf = ["ipython"] -test = ["flufl.flake8", "importlib-resources (>=1.3)", "jaraco.test (>=5.4)", "packaging", "pyfakefs", "pytest (>=6,!=8.1.*)", "pytest-perf (>=0.9.2)"] -type = ["pytest-mypy"] - [[package]] name = "iniconfig" version = "2.0.0" @@ -521,7 +545,6 @@ prompt-toolkit = ">=3.0.41,<3.1.0" pygments = ">=2.4.0" stack-data = "*" traitlets = ">=5" -typing-extensions = {version = "*", markers = "python_version < \"3.10\""} [package.extras] all = ["black", "curio", "docrepr", "exceptiongroup", "ipykernel", "ipyparallel", "ipywidgets", "matplotlib", "matplotlib (!=3.2.0)", "nbconvert", "nbformat", "notebook", "numpy (>=1.22)", "pandas", "pickleshare", "pytest (<7)", "pytest (<7.1)", "pytest-asyncio (<0.22)", "qtconsole", "setuptools (>=18.5)", "sphinx (>=1.3)", "sphinx-rtd-theme", "stack-data", "testpath", "trio", "typing-extensions"] @@ -555,6 +578,23 @@ docs = ["Jinja2 (==2.11.3)", "MarkupSafe (==1.1.1)", "Pygments (==2.8.1)", "alab qa = ["flake8 (==5.0.4)", "mypy (==0.971)", "types-setuptools (==67.2.0.1)"] testing = ["Django", "attrs", "colorama", "docopt", "pytest (<7.0.0)"] +[[package]] +name = "jinja2" +version = "3.1.4" +description = "A very fast and expressive template engine." +optional = false +python-versions = ">=3.7" +files = [ + {file = "jinja2-3.1.4-py3-none-any.whl", hash = "sha256:bc5dd2abb727a5319567b7a813e6a2e7318c39f4f487cfe6c89c6f9c7d25197d"}, + {file = "jinja2-3.1.4.tar.gz", hash = "sha256:4a3aee7acbbe7303aede8e9648d13b8bf88a429282aa6122a993f0ac800cb369"}, +] + +[package.dependencies] +MarkupSafe = ">=2.0" + +[package.extras] +i18n = ["Babel (>=2.7)"] + [[package]] name = "jiter" version = "0.6.1" @@ -648,9 +688,6 @@ files = [ {file = "markdown-3.7.tar.gz", hash = "sha256:2ae2471477cfd02dbbf038d5d9bc226d40def84b4fe2986e49b59b6b472bbed2"}, ] -[package.dependencies] -importlib-metadata = {version = ">=4.4", markers = "python_version < \"3.10\""} - [package.extras] docs = ["mdx-gh-links (>=0.2)", "mkdocs (>=1.5)", "mkdocs-gen-files", "mkdocs-literate-nav", "mkdocs-nature (>=0.6)", "mkdocs-section-index", "mkdocstrings[python]"] testing = ["coverage", "pyyaml"] @@ -679,6 +716,76 @@ profiling = ["gprof2dot"] rtd = ["jupyter_sphinx", "mdit-py-plugins", "myst-parser", "pyyaml", "sphinx", "sphinx-copybutton", "sphinx-design", "sphinx_book_theme"] testing = ["coverage", "pytest", "pytest-cov", "pytest-regressions"] +[[package]] +name = "markupsafe" +version = "3.0.2" +description = "Safely add untrusted strings to HTML/XML markup." +optional = false +python-versions = ">=3.9" +files = [ + {file = "MarkupSafe-3.0.2-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:7e94c425039cde14257288fd61dcfb01963e658efbc0ff54f5306b06054700f8"}, + {file = "MarkupSafe-3.0.2-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:9e2d922824181480953426608b81967de705c3cef4d1af983af849d7bd619158"}, + {file = "MarkupSafe-3.0.2-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:38a9ef736c01fccdd6600705b09dc574584b89bea478200c5fbf112a6b0d5579"}, + {file = "MarkupSafe-3.0.2-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:bbcb445fa71794da8f178f0f6d66789a28d7319071af7a496d4d507ed566270d"}, + {file = "MarkupSafe-3.0.2-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:57cb5a3cf367aeb1d316576250f65edec5bb3be939e9247ae594b4bcbc317dfb"}, + {file = "MarkupSafe-3.0.2-cp310-cp310-musllinux_1_2_aarch64.whl", hash = "sha256:3809ede931876f5b2ec92eef964286840ed3540dadf803dd570c3b7e13141a3b"}, + {file = "MarkupSafe-3.0.2-cp310-cp310-musllinux_1_2_i686.whl", hash = "sha256:e07c3764494e3776c602c1e78e298937c3315ccc9043ead7e685b7f2b8d47b3c"}, + {file = "MarkupSafe-3.0.2-cp310-cp310-musllinux_1_2_x86_64.whl", hash = "sha256:b424c77b206d63d500bcb69fa55ed8d0e6a3774056bdc4839fc9298a7edca171"}, + {file = "MarkupSafe-3.0.2-cp310-cp310-win32.whl", hash = "sha256:fcabf5ff6eea076f859677f5f0b6b5c1a51e70a376b0579e0eadef8db48c6b50"}, + {file = "MarkupSafe-3.0.2-cp310-cp310-win_amd64.whl", hash = "sha256:6af100e168aa82a50e186c82875a5893c5597a0c1ccdb0d8b40240b1f28b969a"}, + {file = "MarkupSafe-3.0.2-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:9025b4018f3a1314059769c7bf15441064b2207cb3f065e6ea1e7359cb46db9d"}, + {file = "MarkupSafe-3.0.2-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:93335ca3812df2f366e80509ae119189886b0f3c2b81325d39efdb84a1e2ae93"}, + {file = "MarkupSafe-3.0.2-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:2cb8438c3cbb25e220c2ab33bb226559e7afb3baec11c4f218ffa7308603c832"}, + {file = "MarkupSafe-3.0.2-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:a123e330ef0853c6e822384873bef7507557d8e4a082961e1defa947aa59ba84"}, + {file = "MarkupSafe-3.0.2-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:1e084f686b92e5b83186b07e8a17fc09e38fff551f3602b249881fec658d3eca"}, + {file = "MarkupSafe-3.0.2-cp311-cp311-musllinux_1_2_aarch64.whl", hash = "sha256:d8213e09c917a951de9d09ecee036d5c7d36cb6cb7dbaece4c71a60d79fb9798"}, + {file = "MarkupSafe-3.0.2-cp311-cp311-musllinux_1_2_i686.whl", hash = "sha256:5b02fb34468b6aaa40dfc198d813a641e3a63b98c2b05a16b9f80b7ec314185e"}, + {file = "MarkupSafe-3.0.2-cp311-cp311-musllinux_1_2_x86_64.whl", hash = "sha256:0bff5e0ae4ef2e1ae4fdf2dfd5b76c75e5c2fa4132d05fc1b0dabcd20c7e28c4"}, + {file = "MarkupSafe-3.0.2-cp311-cp311-win32.whl", hash = "sha256:6c89876f41da747c8d3677a2b540fb32ef5715f97b66eeb0c6b66f5e3ef6f59d"}, + {file = "MarkupSafe-3.0.2-cp311-cp311-win_amd64.whl", hash = "sha256:70a87b411535ccad5ef2f1df5136506a10775d267e197e4cf531ced10537bd6b"}, + {file = "MarkupSafe-3.0.2-cp312-cp312-macosx_10_13_universal2.whl", hash = "sha256:9778bd8ab0a994ebf6f84c2b949e65736d5575320a17ae8984a77fab08db94cf"}, + {file = "MarkupSafe-3.0.2-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:846ade7b71e3536c4e56b386c2a47adf5741d2d8b94ec9dc3e92e5e1ee1e2225"}, + {file = "MarkupSafe-3.0.2-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:1c99d261bd2d5f6b59325c92c73df481e05e57f19837bdca8413b9eac4bd8028"}, + {file = "MarkupSafe-3.0.2-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:e17c96c14e19278594aa4841ec148115f9c7615a47382ecb6b82bd8fea3ab0c8"}, + {file = "MarkupSafe-3.0.2-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:88416bd1e65dcea10bc7569faacb2c20ce071dd1f87539ca2ab364bf6231393c"}, + {file = "MarkupSafe-3.0.2-cp312-cp312-musllinux_1_2_aarch64.whl", hash = "sha256:2181e67807fc2fa785d0592dc2d6206c019b9502410671cc905d132a92866557"}, + {file = "MarkupSafe-3.0.2-cp312-cp312-musllinux_1_2_i686.whl", hash = "sha256:52305740fe773d09cffb16f8ed0427942901f00adedac82ec8b67752f58a1b22"}, + {file = "MarkupSafe-3.0.2-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:ad10d3ded218f1039f11a75f8091880239651b52e9bb592ca27de44eed242a48"}, + {file = "MarkupSafe-3.0.2-cp312-cp312-win32.whl", hash = "sha256:0f4ca02bea9a23221c0182836703cbf8930c5e9454bacce27e767509fa286a30"}, + {file = "MarkupSafe-3.0.2-cp312-cp312-win_amd64.whl", hash = "sha256:8e06879fc22a25ca47312fbe7c8264eb0b662f6db27cb2d3bbbc74b1df4b9b87"}, + {file = "MarkupSafe-3.0.2-cp313-cp313-macosx_10_13_universal2.whl", hash = "sha256:ba9527cdd4c926ed0760bc301f6728ef34d841f405abf9d4f959c478421e4efd"}, + {file = "MarkupSafe-3.0.2-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:f8b3d067f2e40fe93e1ccdd6b2e1d16c43140e76f02fb1319a05cf2b79d99430"}, + {file = "MarkupSafe-3.0.2-cp313-cp313-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:569511d3b58c8791ab4c2e1285575265991e6d8f8700c7be0e88f86cb0672094"}, + {file = "MarkupSafe-3.0.2-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:15ab75ef81add55874e7ab7055e9c397312385bd9ced94920f2802310c930396"}, + {file = "MarkupSafe-3.0.2-cp313-cp313-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:f3818cb119498c0678015754eba762e0d61e5b52d34c8b13d770f0719f7b1d79"}, + {file = "MarkupSafe-3.0.2-cp313-cp313-musllinux_1_2_aarch64.whl", hash = "sha256:cdb82a876c47801bb54a690c5ae105a46b392ac6099881cdfb9f6e95e4014c6a"}, + {file = "MarkupSafe-3.0.2-cp313-cp313-musllinux_1_2_i686.whl", hash = "sha256:cabc348d87e913db6ab4aa100f01b08f481097838bdddf7c7a84b7575b7309ca"}, + {file = "MarkupSafe-3.0.2-cp313-cp313-musllinux_1_2_x86_64.whl", hash = "sha256:444dcda765c8a838eaae23112db52f1efaf750daddb2d9ca300bcae1039adc5c"}, + {file = "MarkupSafe-3.0.2-cp313-cp313-win32.whl", hash = "sha256:bcf3e58998965654fdaff38e58584d8937aa3096ab5354d493c77d1fdd66d7a1"}, + {file = "MarkupSafe-3.0.2-cp313-cp313-win_amd64.whl", hash = "sha256:e6a2a455bd412959b57a172ce6328d2dd1f01cb2135efda2e4576e8a23fa3b0f"}, + {file = "MarkupSafe-3.0.2-cp313-cp313t-macosx_10_13_universal2.whl", hash = "sha256:b5a6b3ada725cea8a5e634536b1b01c30bcdcd7f9c6fff4151548d5bf6b3a36c"}, + {file = "MarkupSafe-3.0.2-cp313-cp313t-macosx_11_0_arm64.whl", hash = "sha256:a904af0a6162c73e3edcb969eeeb53a63ceeb5d8cf642fade7d39e7963a22ddb"}, + {file = "MarkupSafe-3.0.2-cp313-cp313t-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:4aa4e5faecf353ed117801a068ebab7b7e09ffb6e1d5e412dc852e0da018126c"}, + {file = "MarkupSafe-3.0.2-cp313-cp313t-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:c0ef13eaeee5b615fb07c9a7dadb38eac06a0608b41570d8ade51c56539e509d"}, + {file = "MarkupSafe-3.0.2-cp313-cp313t-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:d16a81a06776313e817c951135cf7340a3e91e8c1ff2fac444cfd75fffa04afe"}, + {file = "MarkupSafe-3.0.2-cp313-cp313t-musllinux_1_2_aarch64.whl", hash = "sha256:6381026f158fdb7c72a168278597a5e3a5222e83ea18f543112b2662a9b699c5"}, + {file = "MarkupSafe-3.0.2-cp313-cp313t-musllinux_1_2_i686.whl", hash = "sha256:3d79d162e7be8f996986c064d1c7c817f6df3a77fe3d6859f6f9e7be4b8c213a"}, + {file = "MarkupSafe-3.0.2-cp313-cp313t-musllinux_1_2_x86_64.whl", hash = "sha256:131a3c7689c85f5ad20f9f6fb1b866f402c445b220c19fe4308c0b147ccd2ad9"}, + {file = "MarkupSafe-3.0.2-cp313-cp313t-win32.whl", hash = "sha256:ba8062ed2cf21c07a9e295d5b8a2a5ce678b913b45fdf68c32d95d6c1291e0b6"}, + {file = "MarkupSafe-3.0.2-cp313-cp313t-win_amd64.whl", hash = "sha256:e444a31f8db13eb18ada366ab3cf45fd4b31e4db1236a4448f68778c1d1a5a2f"}, + {file = "MarkupSafe-3.0.2-cp39-cp39-macosx_10_9_universal2.whl", hash = "sha256:eaa0a10b7f72326f1372a713e73c3f739b524b3af41feb43e4921cb529f5929a"}, + {file = "MarkupSafe-3.0.2-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:48032821bbdf20f5799ff537c7ac3d1fba0ba032cfc06194faffa8cda8b560ff"}, + {file = "MarkupSafe-3.0.2-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:1a9d3f5f0901fdec14d8d2f66ef7d035f2157240a433441719ac9a3fba440b13"}, + {file = "MarkupSafe-3.0.2-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:88b49a3b9ff31e19998750c38e030fc7bb937398b1f78cfa599aaef92d693144"}, + {file = "MarkupSafe-3.0.2-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:cfad01eed2c2e0c01fd0ecd2ef42c492f7f93902e39a42fc9ee1692961443a29"}, + {file = "MarkupSafe-3.0.2-cp39-cp39-musllinux_1_2_aarch64.whl", hash = "sha256:1225beacc926f536dc82e45f8a4d68502949dc67eea90eab715dea3a21c1b5f0"}, + {file = "MarkupSafe-3.0.2-cp39-cp39-musllinux_1_2_i686.whl", hash = "sha256:3169b1eefae027567d1ce6ee7cae382c57fe26e82775f460f0b2778beaad66c0"}, + {file = "MarkupSafe-3.0.2-cp39-cp39-musllinux_1_2_x86_64.whl", hash = "sha256:eb7972a85c54febfb25b5c4b4f3af4dcc731994c7da0d8a0b4a6eb0640e1d178"}, + {file = "MarkupSafe-3.0.2-cp39-cp39-win32.whl", hash = "sha256:8c4e8c3ce11e1f92f6536ff07154f9d49677ebaaafc32db9db4620bc11ed480f"}, + {file = "MarkupSafe-3.0.2-cp39-cp39-win_amd64.whl", hash = "sha256:6e296a513ca3d94054c2c881cc913116e90fd030ad1c656b3869762b754f5f8a"}, + {file = "markupsafe-3.0.2.tar.gz", hash = "sha256:ee55d3edf80167e48ea11a923c7386f4669df67d7994554387f84e7d8b0a2bf0"}, +] + [[package]] name = "matplotlib-inline" version = "0.1.7" @@ -1272,6 +1379,162 @@ files = [ {file = "sniffio-1.3.1.tar.gz", hash = "sha256:f4324edc670a0f49750a81b895f35c3adb843cca46f0530f79fc1babb23789dc"}, ] +[[package]] +name = "snowballstemmer" +version = "2.2.0" +description = "This package provides 29 stemmers for 28 languages generated from Snowball algorithms." +optional = false +python-versions = "*" +files = [ + {file = "snowballstemmer-2.2.0-py2.py3-none-any.whl", hash = "sha256:c8e1716e83cc398ae16824e5572ae04e0d9fc2c6b985fb0f900f5f0c96ecba1a"}, + {file = "snowballstemmer-2.2.0.tar.gz", hash = "sha256:09b16deb8547d3412ad7b590689584cd0fe25ec8db3be37788be3810cbf19cb1"}, +] + +[[package]] +name = "sphinx" +version = "8.1.3" +description = "Python documentation generator" +optional = false +python-versions = ">=3.10" +files = [ + {file = "sphinx-8.1.3-py3-none-any.whl", hash = "sha256:09719015511837b76bf6e03e42eb7595ac8c2e41eeb9c29c5b755c6b677992a2"}, + {file = "sphinx-8.1.3.tar.gz", hash = "sha256:43c1911eecb0d3e161ad78611bc905d1ad0e523e4ddc202a58a821773dc4c927"}, +] + +[package.dependencies] +alabaster = ">=0.7.14" +babel = ">=2.13" +colorama = {version = ">=0.4.6", markers = "sys_platform == \"win32\""} +docutils = ">=0.20,<0.22" +imagesize = ">=1.3" +Jinja2 = ">=3.1" +packaging = ">=23.0" +Pygments = ">=2.17" +requests = ">=2.30.0" +snowballstemmer = ">=2.2" +sphinxcontrib-applehelp = ">=1.0.7" +sphinxcontrib-devhelp = ">=1.0.6" +sphinxcontrib-htmlhelp = ">=2.0.6" +sphinxcontrib-jsmath = ">=1.0.1" +sphinxcontrib-qthelp = ">=1.0.6" +sphinxcontrib-serializinghtml = ">=1.1.9" +tomli = {version = ">=2", markers = "python_version < \"3.11\""} + +[package.extras] +docs = ["sphinxcontrib-websupport"] +lint = ["flake8 (>=6.0)", "mypy (==1.11.1)", "pyright (==1.1.384)", "pytest (>=6.0)", "ruff (==0.6.9)", "sphinx-lint (>=0.9)", "tomli (>=2)", "types-Pillow (==10.2.0.20240822)", "types-Pygments (==2.18.0.20240506)", "types-colorama (==0.4.15.20240311)", "types-defusedxml (==0.7.0.20240218)", "types-docutils (==0.21.0.20241005)", "types-requests (==2.32.0.20240914)", "types-urllib3 (==1.26.25.14)"] +test = ["cython (>=3.0)", "defusedxml (>=0.7.1)", "pytest (>=8.0)", "setuptools (>=70.0)", "typing_extensions (>=4.9)"] + +[[package]] +name = "sphinx-click" +version = "6.0.0" +description = "Sphinx extension that automatically documents click applications" +optional = false +python-versions = ">=3.8" +files = [ + {file = "sphinx_click-6.0.0-py3-none-any.whl", hash = "sha256:1e0a3c83bcb7c55497751b19d07ebe56b5d7b85eb76dd399cf9061b497adc317"}, + {file = "sphinx_click-6.0.0.tar.gz", hash = "sha256:f5d664321dc0c6622ff019f1e1c84e58ce0cecfddeb510e004cf60c2a3ab465b"}, +] + +[package.dependencies] +click = ">=8.0" +docutils = "*" +sphinx = ">=4.0" + +[[package]] +name = "sphinxcontrib-applehelp" +version = "2.0.0" +description = "sphinxcontrib-applehelp is a Sphinx extension which outputs Apple help books" +optional = false +python-versions = ">=3.9" +files = [ + {file = "sphinxcontrib_applehelp-2.0.0-py3-none-any.whl", hash = "sha256:4cd3f0ec4ac5dd9c17ec65e9ab272c9b867ea77425228e68ecf08d6b28ddbdb5"}, + {file = "sphinxcontrib_applehelp-2.0.0.tar.gz", hash = "sha256:2f29ef331735ce958efa4734873f084941970894c6090408b079c61b2e1c06d1"}, +] + +[package.extras] +lint = ["mypy", "ruff (==0.5.5)", "types-docutils"] +standalone = ["Sphinx (>=5)"] +test = ["pytest"] + +[[package]] +name = "sphinxcontrib-devhelp" +version = "2.0.0" +description = "sphinxcontrib-devhelp is a sphinx extension which outputs Devhelp documents" +optional = false +python-versions = ">=3.9" +files = [ + {file = "sphinxcontrib_devhelp-2.0.0-py3-none-any.whl", hash = "sha256:aefb8b83854e4b0998877524d1029fd3e6879210422ee3780459e28a1f03a8a2"}, + {file = "sphinxcontrib_devhelp-2.0.0.tar.gz", hash = "sha256:411f5d96d445d1d73bb5d52133377b4248ec79db5c793ce7dbe59e074b4dd1ad"}, +] + +[package.extras] +lint = ["mypy", "ruff (==0.5.5)", "types-docutils"] +standalone = ["Sphinx (>=5)"] +test = ["pytest"] + +[[package]] +name = "sphinxcontrib-htmlhelp" +version = "2.1.0" +description = "sphinxcontrib-htmlhelp is a sphinx extension which renders HTML help files" +optional = false +python-versions = ">=3.9" +files = [ + {file = "sphinxcontrib_htmlhelp-2.1.0-py3-none-any.whl", hash = "sha256:166759820b47002d22914d64a075ce08f4c46818e17cfc9470a9786b759b19f8"}, + {file = "sphinxcontrib_htmlhelp-2.1.0.tar.gz", hash = "sha256:c9e2916ace8aad64cc13a0d233ee22317f2b9025b9cf3295249fa985cc7082e9"}, +] + +[package.extras] +lint = ["mypy", "ruff (==0.5.5)", "types-docutils"] +standalone = ["Sphinx (>=5)"] +test = ["html5lib", "pytest"] + +[[package]] +name = "sphinxcontrib-jsmath" +version = "1.0.1" +description = "A sphinx extension which renders display math in HTML via JavaScript" +optional = false +python-versions = ">=3.5" +files = [ + {file = "sphinxcontrib-jsmath-1.0.1.tar.gz", hash = "sha256:a9925e4a4587247ed2191a22df5f6970656cb8ca2bd6284309578f2153e0c4b8"}, + {file = "sphinxcontrib_jsmath-1.0.1-py2.py3-none-any.whl", hash = "sha256:2ec2eaebfb78f3f2078e73666b1415417a116cc848b72e5172e596c871103178"}, +] + +[package.extras] +test = ["flake8", "mypy", "pytest"] + +[[package]] +name = "sphinxcontrib-qthelp" +version = "2.0.0" +description = "sphinxcontrib-qthelp is a sphinx extension which outputs QtHelp documents" +optional = false +python-versions = ">=3.9" +files = [ + {file = "sphinxcontrib_qthelp-2.0.0-py3-none-any.whl", hash = "sha256:b18a828cdba941ccd6ee8445dbe72ffa3ef8cbe7505d8cd1fa0d42d3f2d5f3eb"}, + {file = "sphinxcontrib_qthelp-2.0.0.tar.gz", hash = "sha256:4fe7d0ac8fc171045be623aba3e2a8f613f8682731f9153bb2e40ece16b9bbab"}, +] + +[package.extras] +lint = ["mypy", "ruff (==0.5.5)", "types-docutils"] +standalone = ["Sphinx (>=5)"] +test = ["defusedxml (>=0.7.1)", "pytest"] + +[[package]] +name = "sphinxcontrib-serializinghtml" +version = "2.0.0" +description = "sphinxcontrib-serializinghtml is a sphinx extension which outputs \"serialized\" HTML files (json and pickle)" +optional = false +python-versions = ">=3.9" +files = [ + {file = "sphinxcontrib_serializinghtml-2.0.0-py3-none-any.whl", hash = "sha256:6e2cb0eef194e10c27ec0023bfeb25badbbb5868244cf5bc5bdc04e4464bf331"}, + {file = "sphinxcontrib_serializinghtml-2.0.0.tar.gz", hash = "sha256:e9d912827f872c029017a53f0ef2180b327c3f7fd23c87229f7a8e8b70031d4d"}, +] + +[package.extras] +lint = ["mypy", "ruff (==0.5.5)", "types-docutils"] +standalone = ["Sphinx (>=5)"] +test = ["pytest"] + [[package]] name = "stack-data" version = "0.6.3" @@ -1407,26 +1670,7 @@ files = [ {file = "wcwidth-0.2.13.tar.gz", hash = "sha256:72ea0c06399eb286d978fdedb6923a9eb47e1c486ce63e9b4e64fc18303972b5"}, ] -[[package]] -name = "zipp" -version = "3.20.2" -description = "Backport of pathlib-compatible object wrapper for zip files" -optional = false -python-versions = ">=3.8" -files = [ - {file = "zipp-3.20.2-py3-none-any.whl", hash = "sha256:a817ac80d6cf4b23bf7f2828b7cabf326f15a001bea8b1f9b49631780ba28350"}, - {file = "zipp-3.20.2.tar.gz", hash = "sha256:bc9eb26f4506fda01b81bcde0ca78103b6e62f991b381fec825435c836edbc29"}, -] - -[package.extras] -check = ["pytest-checkdocs (>=2.4)", "pytest-ruff (>=0.2.1)"] -cover = ["pytest-cov"] -doc = ["furo", "jaraco.packaging (>=9.3)", "jaraco.tidelift (>=1.4)", "rst.linker (>=1.9)", "sphinx (>=3.5)", "sphinx-lint"] -enabler = ["pytest-enabler (>=2.2)"] -test = ["big-O", "importlib-resources", "jaraco.functools", "jaraco.itertools", "jaraco.test", "more-itertools", "pytest (>=6,!=8.1.*)", "pytest-ignore-flaky"] -type = ["pytest-mypy"] - [metadata] lock-version = "2.0" -python-versions = "^3.9" -content-hash = "744c919064c8b43120c05c52d32e1bc36ca59cdc7952757c30f018096c7e1c11" +python-versions = "^3.10" +content-hash = "20efef1e1b074ee0018d068f9e4416e6a0c475ff586f115c890668c7c6f5126f" diff --git a/pyproject.toml b/pyproject.toml index 279ae4e..facef4f 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -7,7 +7,7 @@ license = "MIT" readme = "README.md" [tool.poetry.dependencies] -python = "^3.9" +python = "^3.10" openai = "1.51.2" # Especificando la versión de OpenAI click = "8.1" # Especificando la versión de Click markdown = "3.7" # Especificando la versión de Markdown @@ -28,6 +28,8 @@ pytest = "^6.2.4" ipdb = "^0.13.13" black = "^24.10.0" pre-commit = "^4.0.1" +sphinx = "^8.1.3" +sphinx-click = "^6.0.0" [build-system] requires = ["poetry-core>=1.0.0"]