From b74d540032ff7fd1aa021c4c281b7055a2bac72c Mon Sep 17 00:00:00 2001 From: Ali Elnwegy Date: Fri, 19 Jan 2024 11:24:04 +0100 Subject: [PATCH] added examples --- README.md | 4 +- docs/Makefile | 20 + docs/build/.buildinfo | 4 + docs/build/.doctrees/environment.pickle | Bin 0 -> 26632 bytes docs/build/.doctrees/index.doctree | Bin 0 -> 5574 bytes docs/build/.doctrees/index/usage.doctree | Bin 0 -> 3302 bytes docs/build/.doctrees/usage.doctree | Bin 0 -> 3296 bytes docs/build/.doctrees/usage/index.doctree | Bin 0 -> 3302 bytes docs/build/_sources/index.rst.txt | 24 + docs/build/_sources/index/usage.rst.txt | 16 + docs/build/_sources/usage.rst.txt | 16 + docs/build/_sources/usage/index.rst.txt | 16 + docs/build/_static/alabaster.css | 708 ++++++++++++++ docs/build/_static/basic.css | 925 ++++++++++++++++++ docs/build/_static/custom.css | 1 + docs/build/_static/doctools.js | 156 +++ docs/build/_static/documentation_options.js | 13 + docs/build/_static/file.png | Bin 0 -> 286 bytes docs/build/_static/language_data.js | 199 ++++ docs/build/_static/minus.png | Bin 0 -> 90 bytes docs/build/_static/plus.png | Bin 0 -> 90 bytes docs/build/_static/pygments.css | 84 ++ docs/build/_static/searchtools.js | 574 +++++++++++ docs/build/_static/sphinx_highlight.js | 154 +++ docs/build/doctrees/environment.pickle | Bin 0 -> 18353 bytes docs/build/doctrees/index.doctree | Bin 0 -> 5559 bytes docs/build/genindex.html | 103 ++ docs/build/html/.buildinfo | 4 + docs/build/html/_sources/index.rst.txt | 22 + docs/build/html/_static/alabaster.css | 708 ++++++++++++++ docs/build/html/_static/basic.css | 925 ++++++++++++++++++ docs/build/html/_static/custom.css | 1 + docs/build/html/_static/doctools.js | 156 +++ .../html/_static/documentation_options.js | 13 + docs/build/html/_static/file.png | Bin 0 -> 286 bytes docs/build/html/_static/language_data.js | 199 ++++ docs/build/html/_static/minus.png | Bin 0 -> 90 bytes docs/build/html/_static/plus.png | Bin 0 -> 90 bytes docs/build/html/_static/pygments.css | 84 ++ docs/build/html/_static/searchtools.js | 574 +++++++++++ docs/build/html/_static/sphinx_highlight.js | 154 +++ docs/build/html/genindex.html | 99 ++ docs/build/html/index.html | 111 +++ docs/build/html/objects.inv | Bin 0 -> 253 bytes docs/build/html/search.html | 118 +++ docs/build/html/searchindex.js | 1 + docs/build/index.html | 124 +++ docs/build/index/usage.html | 110 +++ docs/build/objects.inv | Bin 0 -> 267 bytes docs/build/search.html | 122 +++ docs/build/searchindex.js | 1 + docs/build/usage.html | 119 +++ docs/build/usage/index.html | 110 +++ docs/make.bat | 35 + docs/source/conf.py | 28 + docs/source/index.rst | 24 + docs/source/usage.rst | 16 + examples/dc_signal.py | 28 + examples/ramp_signal.py | 29 + examples/sine_signal.py | 28 + examples/square_signal.py | 28 + examples/sweep.py | 28 + examples/whoami.py | 15 + fn_gen/dg2052.py | 35 +- pyproject.toml | 3 + 65 files changed, 7053 insertions(+), 16 deletions(-) create mode 100644 docs/Makefile create mode 100644 docs/build/.buildinfo create mode 100644 docs/build/.doctrees/environment.pickle create mode 100644 docs/build/.doctrees/index.doctree create mode 100644 docs/build/.doctrees/index/usage.doctree create mode 100644 docs/build/.doctrees/usage.doctree create mode 100644 docs/build/.doctrees/usage/index.doctree create mode 100644 docs/build/_sources/index.rst.txt create mode 100644 docs/build/_sources/index/usage.rst.txt create mode 100644 docs/build/_sources/usage.rst.txt create mode 100644 docs/build/_sources/usage/index.rst.txt create mode 100644 docs/build/_static/alabaster.css create mode 100644 docs/build/_static/basic.css create mode 100644 docs/build/_static/custom.css create mode 100644 docs/build/_static/doctools.js create mode 100644 docs/build/_static/documentation_options.js create mode 100644 docs/build/_static/file.png create mode 100644 docs/build/_static/language_data.js create mode 100644 docs/build/_static/minus.png create mode 100644 docs/build/_static/plus.png create mode 100644 docs/build/_static/pygments.css create mode 100644 docs/build/_static/searchtools.js create mode 100644 docs/build/_static/sphinx_highlight.js create mode 100644 docs/build/doctrees/environment.pickle create mode 100644 docs/build/doctrees/index.doctree create mode 100644 docs/build/genindex.html create mode 100644 docs/build/html/.buildinfo create mode 100644 docs/build/html/_sources/index.rst.txt create mode 100644 docs/build/html/_static/alabaster.css create mode 100644 docs/build/html/_static/basic.css create mode 100644 docs/build/html/_static/custom.css create mode 100644 docs/build/html/_static/doctools.js create mode 100644 docs/build/html/_static/documentation_options.js create mode 100644 docs/build/html/_static/file.png create mode 100644 docs/build/html/_static/language_data.js create mode 100644 docs/build/html/_static/minus.png create mode 100644 docs/build/html/_static/plus.png create mode 100644 docs/build/html/_static/pygments.css create mode 100644 docs/build/html/_static/searchtools.js create mode 100644 docs/build/html/_static/sphinx_highlight.js create mode 100644 docs/build/html/genindex.html create mode 100644 docs/build/html/index.html create mode 100644 docs/build/html/objects.inv create mode 100644 docs/build/html/search.html create mode 100644 docs/build/html/searchindex.js create mode 100644 docs/build/index.html create mode 100644 docs/build/index/usage.html create mode 100644 docs/build/objects.inv create mode 100644 docs/build/search.html create mode 100644 docs/build/searchindex.js create mode 100644 docs/build/usage.html create mode 100644 docs/build/usage/index.html create mode 100644 docs/make.bat create mode 100644 docs/source/conf.py create mode 100644 docs/source/index.rst create mode 100644 docs/source/usage.rst create mode 100644 examples/dc_signal.py create mode 100644 examples/ramp_signal.py create mode 100644 examples/sine_signal.py create mode 100644 examples/square_signal.py create mode 100644 examples/sweep.py create mode 100644 examples/whoami.py diff --git a/README.md b/README.md index bf35370..d93465c 100644 --- a/README.md +++ b/README.md @@ -96,7 +96,7 @@ If you have run out of energy or time for your project, put a note at the top of ### Description: A library for usage with SCPI compliant function generators (for now the DG2000 series from rigol) ### Usage: -#### Linux +#### Linux ```bash # Clone Repository and change to repo directory @@ -114,7 +114,7 @@ python -m build # Deactivate virtual enviroment deactivate ``` -#### Windows +#### Windows ```powershell # Clone Repository and change to repo directory diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..d0c3cbf --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,20 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line, and also +# from the environment for the first two. +SPHINXOPTS ?= +SPHINXBUILD ?= sphinx-build +SOURCEDIR = source +BUILDDIR = build + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.PHONY: help Makefile + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/docs/build/.buildinfo b/docs/build/.buildinfo new file mode 100644 index 0000000..0b451fb --- /dev/null +++ b/docs/build/.buildinfo @@ -0,0 +1,4 @@ +# Sphinx build info version 1 +# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. +config: 47101a726535b145db2ce530805d96c6 +tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/docs/build/.doctrees/environment.pickle b/docs/build/.doctrees/environment.pickle new file mode 100644 index 0000000000000000000000000000000000000000..7fe92ec9f6c66f1bbfe656f84c5e97fe4caaf800 GIT binary patch literal 26632 zcmeHQd5~pSS)b{d-uGED6OzbF2+%X6yAu+&fy4}xm7a9QOaehN+}wWecHevYy?fu> zWu`lE06}0Hjs=*9m_iC%s@zbtEGWt<%dIRciTa0@mXv6@l~AJPUaqLW@B7ZV%j?&( z^n^r|{^Q(t&wjr1ec$=EbNfC0AOHHw4*t`7lC~d&Yja+BCWxc3<%MZSPrW${nvJ_l zSxgXZoWE!8qTjwb> z+&SOTyZxx;b#$K_cJ%OFQ9YyKl8)YWZ-7xp)6Dmsl^|`pXg#nTIx8M3?#584)4xP> zLc2LLbka#X520QX*J&31@Qgp=kNRW&xIf`f`cwWi%Azc;d!}MN3YUYGjvhDDweJJR zq#$48aCF9t*p4IR)zgkYrHAWLdp!AW7XcsOKFHI+B6j zCcJjGWKIW}zo z)v}n@cu%l0$65WUyVOL^(8KiPtdV-u@Mf2qQGFHdj|WK_gez2%>47tDGvj@j@m~%= z?*g877C+eWXZ%C{efXiL%{DltE!aV*2B2`wSNN~=AE26p*j3uSj(?n+`iK2jNgw@b z)Nt2rz8>aRXStPj7Nx>a(+yWLcLnqA15QfjC?@PSJqOq)2qEuD$CdJfvUta~WhjR( z?b20G#!-}>n|sohoqH0f(H%S1y4VlhJi_yXX`2eYdu;Hzl@rGzJobRtl-EkotC&`wVgEgXp z-E(n5oB=(jaaK>Us|}iCCy^GDriB+`GqHWZ#4KH&ef?|_tjI9_ynnOQoeILuSloB` zum#*$!&`Q%C;d`{c^QKp-(25!vwuGRZ7wk!+x)UuC ztvYBF2Sw3KHy1gH5132;gu#ud&j){!RX@AorwY6V4Ji z7Z7z(^2b*_ukD<5;}DyYPi8vF+HFRXyyTP_>?(kekpl$PYDFRN$s-&5c;I;L zpc$>$t>G-7T`6l11By5`@Wokfx)|H+(?lCEbmMg(979(3wLyAJ%VQxrNjF}o?BdEp4xkkiorlK&-YwWr8)N)*Ipraq(&EO<)lk8*u;YU7~ciZUa+ zcXJB#O|ffe8YN;JcntdPI~FhL_VyXI>S6P_;mzk!IK%|oMrb+0C1R0|MmVGxYR%5 zzfpeN>fa{yC%Hbja_m-DykEM8tl?zs24q>B+AK)%Fd|GQz|bWZ#ExT(v!xLZaKJkX z-6pyuq_D+%xlcJSXm5i$voCHc6KQ)8MS%*d#MU@}AGay;9bTC3`_(U)F-6oZV+*%4 zKyEjK)S%IZbSMQRWjaQ!sEou|DFrkSJB_P&8b!VpsUT3Lke;M#SszUWG!iDB8`pi3 zMoSYS0<>+-mdS)@u&x5>jwe(I#b&YxWj-Y1$T(=*qT|?3I7c#6kaO6y6bvC^A+gVH zjet4I(soADl@_}N*U4;+$FoL|o z0-YM!xnqZHnT*UQH^f66YZ%!a%G~p94sjM_8q|U)lllrwk96mbexskJ?c~V(e7zCQ zsifgGgER45=%w>vyESj>-g)c1m%L^kn=#vJHD~KIH&ixIV?l#@>}EO>b|}L+>6Gq! zYzBJGV~0APOh0ej2ojvl>wJ{=J@yW&bjnuBI|4?KY+`oAwtY3k$6oojcIR7N$Djw$ zaEXrWDVtA96>FBJV9XX|bQ*3*?L9UVXLjU>rNA6OFUgAv?vlDOa!EvybLD`o1C0r+ z)o5Czv0r`9Bgc=|7LPt~ckNAgKXCN^<98mt>#m3HK6&zvj*Ps&Xet^a^mVrdo5=B_ zi}yZq^j@?(e*Dg6Fc-xuw#^u+_-mk+6*{~0P`d#E896{STKc3E+Y^8#DSt(e$O$n= z6$|S~*`zQ4X)D9wltPi>o<^i6!{<3`O0rvL*j&X^}?lrgz3`g0-+5NqXR-)YvCAHu3Osx21!EZbHgnND)I4m=fn-CHbZEB$r>fd|Jxc5@D#9=wN6midK;c!2$-IW)#QK*#!8` zZAMKS7R%J9iPkya%umk#618!mfp%3e;1V-+Y%;6q#7|8N@N>w1_0>XUk&S?~Ee}V6-TP9>*(hEmDSx4VQzJL5L$aZhfxA0cjATj*fatz=UT<-{wpBe+q*ygP zBpqH`RE$Aw;NC49@ph{B-WmTg>k?9V7^Gx`5MTzVFE>X{R0TBx-XV8kXHIkD)Uv>2 zgQ+i}+?KnFGh9f6tVZ}1;ovn@_9h^grYGmK6_C^|`Jplm!VkjbhzvExa9W)jw3kEb zUr}Gb^uf?0xOlaa)LV;|Yu03`#~%oiy4S>cij7JNj_W=ndLcRuq1 zEPBWqQ4H?ww_Su-pqIKq6C|Bk*c`N_^*DlME4RDk*g`|37PfVtWJ^7G`1aX%-SDc% z4U-?|Dxr6l0E6P)SqQU+8~}T{j0{M*C_-JcqD3>~u8rDW5m7`HTZ8=-W|B0`_3_EN z6EqwcX<4zra6l8TyN4{X5DI#gP1PL{s8_vp5K2RI=t0P}Fe%W2_*b-yxr0+RkwJ%M zlg@)-Qlo;9#8Qa=VoJ8Y>0XX7cov<}R?1mneldb=$m z@n+KycQnlvdMYij>#6jT<}gJyA%A5nSVOc5J=0Q8QNUP6&IwyKquevDXn&VB z%GI!O2JMn5XUVOv!uXo_=#rOueR~}y{m`M4FbhxP)FoxU;iT(rYkf2|Z!|S8X?Zu8 z%0}=aJ_212s)!duDWcAEO?f{k6x_mVwju9?4P*3VXGC7Y29dq_tE~vRX;IzNw_^uM z8~cjlhIfW6VQj|l_rh5)hP>LrqM8}b8e#O#TZ(EEMKw_*^A1YmtS*s}x&bRP91g-x zXRQw;uRm4vg!*ja%gaiA#a@dnvDNYeMO!gt+OuUN@8asBN-GEQfi8h; zBQ)thnwOX6D7JrCh4RA5Vg#eCkD8<7K5SY6vTKTZq*{>u5WIuTLtrPxK9x2guO@cY zQ$=4_6@Br-p;3uSF*%53*LSmpgno9VobEht*mih+QujmGzY{K@JjHsu;!78n==_jr|HnER?))(EF5;`gkVLGEA`NYi$Xf(tr}@{lG6~t zh)#;}jcRQQ*j>ODeA8mg6tLh1Z%GKF#2KrQmdm>Jt1Mg6?vo?`64hLKFccGh#KHq5BQ{vOo;oKo@vw1;O|LU&3ii3fsvA3&~ROQY>pWfepFCRxxh=8xdWimJTU<3 ziP}|qnh3&*WywFSC(wX7sNlN+zEV4Swaf-f`>R$pI#z4-HOymESTApD1bUu&|N)QjbDEZHgvAZ^mB;g+4{F zg*ah=BPiNMRP3} z2+K3P%XCsDbEZ8ByQJpl&DEb^{`xs{sM_9{H`K(}U8CK-saD70V27?Pt&hm8W>05W z9c1G;twmw&;moVO#SLq>yta1B>yEtUmLsoueT{-R=0@HgWwkm=+=kmuYpEY3++|JV z?$m3p*V3rAjwlnTTdN?-n`-bQ)Pl4I$t`O(YHnJiD325&4)7ZUA^PxYV@Jdt56c?3nHQh&5J@tay3nE!e4+jV zBdWinmN58JtI5aF9Kqvj=te-UK4oc5r)ZNuS}|Lq3d&e`5G^)C!Y9jET5daMD0u**oLZI*uEUG@dEM`lt`g>&1q5h9}0we!f9{(bbf0M_5@FP?I zji(xo_RW~J$L@uAARPN;WJM^r(^G#pG=>5I-WmN15vuQ6ReMc3YTIi!8IHVHI`ax zXM@zQoji8p{@TpRfVAb>G4K&LY}6oEfd-={S8jny;j||PQ@cN;7#B7v9uiUyTx8qe z6NKl4(8plANpgxc8##c65saSIC5;qIs_vLIDpmI6rCrdwl0CVO`rE`x>LV!F)jiEASp6YzAIwFV`Bs%KotR`U zEOrk97dco7aVb`I{{TWP#>_EpZQAO7tO$`8urL^Zd>^R3Y)M}>JgmQ#gzEfj-nnU^b$Vsrf&F- z%9`FlRkmU*deT5}_AGb;ytW-zU4YlT4t@37wer4#i*;j%zW%K6)Y&weT@GhK$g|0; zW&fg8xK&oCZ!k?R#D-nfgCY8N$P9_ImT|X)dBhEOVJRj4mm}7U8mgA)J@<>prbf(* zeHXCL7=eN5x>tn?87TtW^Um&9x_T`waGxck(WMOXsyKhQAQHnuhsi(ez~a@a*3*+m zaKs;Z9DBy+?Bn^`4_4u%zMJM_;KI}iO$LyIqP2z|s=Zb!lhnmt+zR`yRAD#|**QS0 z=BQ}dXx#;ei!tsQy_+Wl86Ene9z;4z6Z9^G`Q&7l;m%{YE$OLe7kU8Q1KT@Bt>-t6 z!Bd|=XBr{N%VcAO)c3A-1_Uwp66D$Wjg%oc00U8-0Bv7s&Y+LV$lO~K6mua z!yPm4HO#LU8?PSsJ%p@1IG-u9WEOJDtdUc?r7ByeEX!1><_$EZn#*PLk~zW9b7-8Q7`IYoUfv8qVr*jsD$CFMHiArjlG{uo4Au@ zUfCC>$01O|1Pdb`44*K+!J(IucX*F=yq5}L86PKODaE&oO%*v4;sk~M!m6&`!6Xbhz#Ie#@A^CGyrfg31>-RlI>^rE{2;hcN0(p z2D}!no@~d69K}7M^SXy+_}Z$m*ugC>#DKt=0QV?@xkx)F3#p#mDqc}v*HzNhh5C-& zwCB?Arf5ffZMC4Qv7XA^$N&t*yu(nx$w<5xVIlDS(>;U2-n*y=#DzpaD2)9uns(d& z)#nH+#~WD-{%h+f04zBp0M3z%jyz72oWsaZR`epPjiARy=Au1jW^?8EKe#&E`KgcA%TL&o?`Li#-`8H7GW+z0|ouR%+9SwuC z+3@rs|9u9SPPx6^AzeNp^>Z}dWqE{pIaCl10TG7N^VmKab97+#kEBT`&hg@y89>wP9>2i+LLoN`Z zwG=h;Yhqk=Usq;cd$`i$upN~f?Wy$7{tEJ9?(go)l)zvE-cX0N3i#7e&(H=B9y6~` z0fOx8nSkXL6pagVi+5ccN^E)eTt2uNGC{_1j%5=%Gjc5~{%d|10wNHF^BH zJbr^8MjUzuF9Mh6=vQeM)U%Yqiz0_em%T>c{%{0ay=R;pH<3H7MwkBB;zn@|@TtKu zNM5y!VkB$ge3slJxfzJpdWC&efb-?9Wn2Mp%I*%x)CD{SdqK<^&Bkrumt2ju5~BD? zo}8IO@W`1%wHs^gpk0Hrm$qMkGEyoNzsPKBQ%S?4%YJ7dPmWZ(z*(Le_tq@mOrLG9 z-#UvB7!MNt`rKI`(L-fId{Jj2J0?*48*CU{iMdPQ;;6fYw@~*(B%=Ggx^(dy{^u~E z3(2@7pWoSq4UEnP!yURdtg_R_%TT3_vgRVQCF_2PkliZbZ7S_Sh%h8dU_hrgmnvZ& zsIkzT%=jiqsC(c%yT^!XwBM3GvE405AN=gHw#I(Ef#?{DYyPEL<<`evk7ky3ZzWnrhfTORjtg?l-@kJJ09pijMp9{p-T z9>=-p0Ztc@o>vbdE#H+_Cn&?JD(WG6>zCV9>S4U78wuEtl(XMPFPoJM^>)gq?-i); z#IHs54o)9KiZl2W9;_^=cXGDF>EoQboGx)%=d{78hg8sKncr8C;%o@;IIk2^z+)8; zh~uh>=b~yMWx-p8_*Ig!Rh!FCQ#r}gD#ot`5~Ni^HAQq*8GfHvXQ&p*$LcJ8ZKyR) z*O6ktC-~(_q%6{^@8b7!NYATx(Qg(})w}U?QN0H#X8c|}&UMuH$m0X@I4_S6@nc3! z6Pza~8KR^gNv3qEaDxj<9}QppODAX^7y1YJ|&M& zc{XC{rrSHehQC8^;voO8Ggx+UlPYy5R>qP7gQX(pTNK~ zIfh@~XmRYGuFu}O9IHYM;@DqgGvR+S@dKE@f2*&a-=rsD6;>f@6G$$!C>Hi19*AEk%KTXNglzcyuLinP>4K64N zUtF2VjVdc5^%qz8B5K6Z!B-((Koi)PX!U&B|1N&@lDW1M()s&cy>2%|mSw9KSgQJ3 z*W7yu4%-NF{c2aQ>MNA-O(#|TTh}tK1UM#6rvQWzr>da(mN>PQRjq8x8XTyKQy0fj z^>tE^{|iZOzVhEjSA;KOwNhWh!3I-Rv28|L>fW|OT9L_Yl7}iW;+sk@5F**lT}pGQ zn5fLSxj0lEFwefgNW>G%+_5xLMMSzdxbu&TN*A{Ph~!dHpV^aw=+bi;<$B61@2pW%CnxKvbtZXGi&86R@c&2-17mP$D8 zd7ADn&?mRHxNDQwms>~_)GMDet;R?f)wa1;PhK|E=&GUwoFLGLA^@^DFj31Ra+jYR z{kSw}Hg%mK$U5*Df?&zfaLIU)=3SiTF4R_FSGO1YVccMJ5fM=0YfyCkA@@LCd~}&L z-S<%UQp@`&S)k-NB@ZBh6Je2l(;W+S0?CH@4o)B9^dwT8I1ls7BS_U-DR~k`!@=3dK?5$a$j#k z{eQV~F#gkayC_iq@3-4U!Tn@2w?RF{EPm%oWY-I=40Nh3H?E(%&{3nvEQ^g>^z zC#Vhr0_0jB$FXr1KG|5xnnEqUs!$oe zEW%Ykn&@%5Ux+H)7k@`!S_YvnBb9RT-y`VS5lfJmv))-JX$SX>a53JI;I@wX6j9~C zNsgr}1QI&E5M!ML_}+53a&!sbKSs=JMgE)CVgW=R2_>~6(F+kLtk+rCfQAz>AK!^w9 z2PsB;!hRS21falCzGF7$D8;TUs=K-AJ)DxHu&D0E?+tYyQf&WQ_<>cM%lD-PnQuLm zRx{X*iRgeZ@l+?vbRWJ>N_CH;M~ddetsZ=B+`+d9Ijl{ZldQDC zy+T#8u%&Ov7tK_QhsaBJ(RW!&#kLh+yhFYorNIB<@49ET*dt+Ok{mF zzwHD;==~T95|H{Jp6WajJ@x>D4VTo54(t^c^?f|E9<4@C@;7p8CnzFQMy(9hJ+R(u zF4T981`USjp@0hm!$9N%9i?fW-^;VW8%@W|32&dEw;wQNcIyyPiBE44h=Cyk=40Tv z*&zRwhCfxMr|!XLJV@YwBn(d9CEqv!P(IQDDK?sN4O;yuI@aTN;XCT|)f;M&81V1G zXS?a!cun)6U(zLjf5Suvj^ROk*O6k<>0^IXx(`f~KErH2c$cee`ardSMyILK3iSSJ zSqnFr!KA3?UrbCgP@|iEXmpq-vq^OQ`~?LWC7)1>zyPnZ0**XYBjc znYr;=0;vcU#bqj0%H<*A2^9gViU0|C;RPOeNb<&CfGQ*;p7{g#&CI>K*K6#AN3gWk zoik_7%$)N(U-Mq$$A3IGW&iYPnK7OWH%J&JX-H+EXTvneW16VqL9zDz;(NuaZV9q0 z(_93!&{N`0hlj0607Y)DSk=!T+%mitCU_EQ-C;h}9(8Q}`6UEcSi-}ZJczqtx zt6m@|Q8e^=du?~7&bv7ecBCRgd0>7gr{32{;$8oucl}G7uU+4K?RD>!Yp=Yz(f&@F zdjV!hNHXOq#-$bM;T%~+6^-^hm3n))fEV!{o(!&fy)j3NWGqF`;d!lrf0uYgiu)U2@gMwg{A?UJPXl@g<}`xaMSl{4lKxQa-x>wwn9 zdf9dBx;zQ#a6?E{=u;6-XmP8N_h7&oX)Ky1BcQVeYZ~LOVzQwikJhI2OW&puAVm$B z+%8w-K|o(}&{)!+Kg9akdk+sWJ5{gZ#@E?pHqEYVv9+zdN7(bwF*^^Cy@=mM{62@@ zr8`B=US?geUv=zkm95>Hu~%uqTx1|f#_A{j)%v~&y@aSRU zJ-Pq*XODi8JbL&<3;O62_2{AKu6b}B;@#d;3=S9Zo*-h+>!-rYB^gj}mn-JIedG2` zZ}n|%e9OB5S0_p6-4-c4C5NjbRZ&K;F>8@6cwfNSvYw@el;+xRilK%LAK{Mk!zFEH`Jr*f%uqzfJ ztqL&~DYGUjrg;+9)ay{srr?Jz+#Q}f3X*I^H>`gl7{K0w+Yqp&8x}Fe4-2B_c@ji< zNKKeGQGf}eXJax9X{K0l>m;HG;2Yx%YhQ74xLPbZVoqo~*$UCxAg*2P{Ah2|9{Zh$%TwEdb5U`G|rzb+d7hI|y zN3d%ZK`-A-LLN|fHXK!vp0R>WVN3sUYK*l9b*w!-Dt%Nt(pihOxn3S20s9e0?5(Pa z@ey0PWoCS?Xk44tr#F!=Ht#}f7Fl=QX}?@uh<##DKc(k0ikl?^e+d4XfRX`$geNxM z*S2rW_#JHX+etXpnRFBD0EL33sH@Cp zjEbXRf7UY?sl5!TaoUL1bNEk(S;PabfM_$lOGHxKx9dG_Ic`7ILVNK;kd*3C3mS+0sL z*4@%A#BNtK78r!+8qp-i83uE1LnNGJ2g7zb%teIJ0&==7oaSnF6Ehz0?L%O5+Yx86dKuLSNf(v_N$%(3<(@xVhDGe*7&=)6W zCPZw1*SP1RlRG{`wfe%riHXJfjJX4_CK*%|*#>bTBFP{}-vNz>$ciUX1nTF|g{LC) zQ9J@E*v1r`Te^wPy^m``BRm9FQEUzi*3^q6SE)ZH>60ArS_tzv^G6VbVl9CKeIg-| z5qR2CtOFSHk4c%Nd6@cWWWjX?`8k!;udlQy36y`2OOC$A$nrxjP2Giyl&74jTmx=4 zkIP6ngR2XHnv%`03TC}xzOV_}Wm6}^HbzK4&=X0l?{_RD*ex z?cZtEdHLF_(C4D)2NU8AWi0-3B_7U73}knx*x*$4?H&jKU8dp)o3#+$;6oal>4>m)e@d1nQvmL%^9re77@owb5o5Qaq6!n}PyP+SY0dc*E zz8Elc&H)VX{0&;RD#YrYJVV)Kp0{jgQN{tZA)xT24-8a+VcCQVnfE66cx=EMrNnuo zd3)F?fEn~GAzXM5M_?2++`c{+fNRI6Cmd9H_QCcy;ON_1CMW8anKMPJ%?s?qeLK0Iv-9Q&;{$fp^0AL{y-+u!mAint*5wxL zkWDQepPEmqsIGSmN0U;)uI-Kw_)f)h=2-Am6?G~9phCxsM+B8axyUCoH%j^gXzl&toA3*~%D}_$EM}fh+=io&a)3NHB3on5m7OlY UGca#!?a)NMGC-IDEbndn8x4P0*Z=?k literal 0 HcmV?d00001 diff --git a/docs/build/.doctrees/index/usage.doctree b/docs/build/.doctrees/index/usage.doctree new file mode 100644 index 0000000000000000000000000000000000000000..8191399c6c89bb4a28c45fd175fc99f6069dcc85 GIT binary patch literal 3302 zcmc&$-)~zr6do&Sn>J0`jZH|bkO{^%u_Q(CfF^;E03kF{Aq2clmUFKYd%f4b_(z)x zA;H5WD*0{Zk-v<8hR@eGH)$pi5)VX*bbWk$e9rOrefBS%-~a4gtABpqR9wjUh~~Le zIWxg;=PGk0lQz5v4}T3mhX=l^>A6u(XDs+@@W{9*a?NCT8hk&xTTz%%vwq94%nBvj z<-Ef;`PS3$fOmbz3R|$1Dc||t&>0KS0rRhZ$L4Y4h530%8EjS*``N$`eV4Qe@(sV) z{PR9^l^U6 z(pj7ee4oF;d;AXH;79(8F;^uUQ#t;;X_Xm&DeTxf&dCe~(#d!#$&AS{QZ?h0;#kO> z&Brd5JJJTVy!qt1oABM#)9jEM0_?xi@{4EsD z@1m)1<9`qT`}jXZQT)BSm|=3~kB~+OX>@%TJ*G2FE53R@AAhF?&ago$=+WRpxq)OX zA6PY*3e+)}IG|x5EZl^g4XO*vl}y&h>0EF7{}^Ri<){C?%1`)FUELO%Q&(G8xmO6w zG%d)aP}%8fr9V9woiTa#aPZEc64gMY-lsx#R_0QD!}6t>oKYbEj9RvHHAF6qZ4fa$ z9vzR~A66G145gB6Nae-ooEM8e{jWKsE~8uDn129}@6OBOv8iZOgY8N)!}J+GJ5v<} z;?i#yRL)!^H3+AqQ6RkUb1~xu{+3WZi?obDJZX-oyF4P+BG>ntBS`S43naf}UqSW` z0yQ*UAbTZXrzT%mMrsXfAvRXX0gnDXn_B(hkNj&^Q)v=eNu|{ctx5XRu?jQ}Pp7o_NR2gp*gOG0|3oBS{A?Lz!ve0Dg*eqy7`o#A% ztCY5+U}p^NyY6>5E!ttnAF{bX*DSTpESx&Nle3ANVY~i0)e>EUhi0^drHl4wEEW}h z^L-)FBf?~+a(D&bb#^-ZXlMk!?_8ZEOlzeHr!p^?M#p2SnGJqFb$TUAr;ZZ*(b~*f z2>yrfr=ZIO7EAA3omgAx4`KlTn&IeAQS)$b!8x=$2i>mYa`rbh%aqPZ&MLqJ+X!If z#BYL>Q`Crdh#Wv=Q!x*G)Ay;fiY!h3x&XHJa#vQQ#UHv_8w8-IB`spW{n}C^JD&a0 zR2k-SMW7e(I$-lk8AeuD))2`oITJ=CeC`v7C7l!ug)~`iEqDQr^-zof6OtqVGL0LV ziXz?Sx8oN!fhxsY69*Hc#Ih2{V{shYun+GYe~5ne^)y=x zA1%x9?=HfFsWjsClrMBozWQJIiaU|^vNH=<4$H(B!&B`yqXMiUj|W9~EnGv$Qk;O_-e;EY*paw~(^ zDPbiQ1;Mj5s%)M1Ve{|=Sc_@Wv`fE%8$CV>{dUq4kQY$IQ%ryymRMXy4BCVT;USU& zv@9O8fK48sfIma+u2|DE5oSc2wu8+`A-phQ--^cc{eWw(_%l9pz8kIfqC%SSRi-cb zvrEVC#&3n|YQ~4o@2wtP9cwQW064SQuShUEO@bK60G93D@rZ0?gI%C0Kf=9+hk!vQyv*7#D-HO7Dn)MroWmYKJ zF6SM-&NrTgL*DfrD{R4*rhMlILuV{R2h3mno}I>x=jK--Ww2gR>}Lbt_g&H^$k+UO zlh={IS_sL)k(*GzMXl9h;w1#80)nYKA*|BER=;Qo` zrL#B{_%6TAd;AVx;|Kn;F;^uUQ#t;!X_Xm&CG6Nb&dCe~(#d!#$&AS{QZ?h0;@HJP zN7|r@yHBsU3ExibUG!&fZt%UYrLnXqXx+)WIk#4fO>25AA#h z|NHnq!2co2;qTXF43j&5gfu!xqwBlqE}dyw@#T~GWU@XNe1vy4t$RokCcqX+b81 z%8r*S{rPZo!sN-r!MlS>R0ENEp9-P5voVk#PSV6)Q9Fnxm0&QwKdIQN?c zl`|LV45}$<6sYd|T+DcZza>=9A|WFXkD4RuE{=$`$o0ME2on719LaCkmyo@MKn+3X z$X*KAsmT`>ky^t_h_xkhfTMrUrdE0QBY(qcDor9QskEA*HA#6oR)NOh=_S84_hC7P zF81KE?`KX&T_dfE_2!nOW`5H!Ye6mu^M0$eQ>~0Y~#9O5U207pfQ7J17w$p|LyBuS<)eN03Fxs&yBT)zAEH>^SLwy$fwW(58D$AB8 zpI-JmQShZJ$tiG923YzA@>`KimGK@i2zfhMSix!wc_Az(b2Y|}&4Nark9<$FN@+_9 zcEZrUD}Ia9q8)bpK06iYnx)p6xl_k?ayD@@Y}bE5wM5t8p&2b<>7xA^i$#Usd|ycP zh%lL{9A3e9ot+Lp9vXq~I~OMj(^_f5smu$e(eapSW`o~NonDI4siOpcurjj}g8$+B zDd-}B`O-TVCstPay;uN%W;ps&)I8joa}Mp!LANWomi=|jGNp5pvkEZ5HUbzq^6Mbw z6g8q9A_q{}RGbFB?)%hPMHVK1MF3knxhpHu;tyS|4Fb^9k`^)GZf&WN9nXGYstj|v zBG3zX?XlBJ8Ag^@))2`oIT1!AeC`s6C7l!ug)~`i%y|Kh^-zof6OtqVGL0LViXz?P zx8fHzfhxsY69*Hc#Ih2{V{sgtun+G){s{f->uI(UK3W#x z->qPm7TBz7=>!zYEe}sO{Q&@3l9roo0VFB)x!*Hq($Z7X z3UR<=Nk!cEOi97ApBzYS(5UP6I1LGIN!qmbAmex;WH|UlHgvgeAyyx|3d$c}f%Vg_ z5rK1{M`c1zfq}UyT#Gtk++@X1l(;ak8BJ7-&$#0N%#;(BgTH4;fiq^Y$;}L2$Apzs z6a){}sIqn1`^}RRU@fLe)6V@GZuIyZ^qWabKwdym$XtLNmRMXy4BCXJ;69Q9v@D*n zfK47Be=nhS7p&=l2s5Hh+rfII5Z;!sZ$xAIKIED!{+!R8??$UVtB_`VmFaW-{M_+- z@mt}#n(?9YJIhB`$J)sR01%Tw{A7s?o%^Mvmo3Q;rQoQ`i7Hw&)UG#HjIDR~Ld5QT z*Lu;l3-O_}+D2)=xf-jP!378X$drrf5d3zgiUMs$4Y)uyzG&>P(S=vxJ8%InPOu6u o@c1ZB8@4iX!Mxp?>jT^tGAmpj0W*tdx0OewYeXU5-EK1a3x>D>JOBUy literal 0 HcmV?d00001 diff --git a/docs/build/.doctrees/usage/index.doctree b/docs/build/.doctrees/usage/index.doctree new file mode 100644 index 0000000000000000000000000000000000000000..6a42c78121733bd12bf8a96608da47fd66cc78ae GIT binary patch literal 3302 zcmc&$-)~zr6do&Sn>J0`jZH|bkO{^%u_Q(CfF^;E03kF{Aq2clmUFKYd%f4b_(z)x zA;H5WD*0{Zk-v<8hR@eGH)$pi5)VX*bbWk$e9rOrefBS%-~a4gtABpqR9wjUh~~Le zIWxg;=PGk0lQz5v4}T3mhX=l^>A6u(XDs+@@W{9*a?NCT8hk&xTTz%%vwq94%nBvj z<-Ef;`PS3$fOmbz3R|$1Dc||t&>0KS0rRhZ$L4Y4h530%8EjS*``N$`eV4Qe@(sV) z{PR9^l^U6 z(pj7ee4oF;d;AXH;79(8F;^uUQ#t;;X_Xm&DeTxf&dCe~(#d!#$&AS{QZ?h0;@HJP z$3o_8KGFuYy!qt1oABM#)9jEM0_?xi@{4EsD z@1m)1<9`qT`}jXZQT)BSm|=3~kB~+OX>@%TJ*G2FE53R@AAhF?&ago$=+WRpxq)OX zA6PY*3e+)}IG|x5EZl^g4XO*vl}y&h>0EF7{}^Ri<){C?%1`)FUELO%Q&(G8xmO6w zG%d)aP}%8fr9V9woiTa#aPZEc64gMY-lsx#R_0QD!}6t>oKYbEj9RvHHAF6qZ4fa$ z9vzR~A66G145gB6Nae-ooEM8e{jWKsE~8uDn129}@6OBOv8iZOgY8N)!}J+GJ5v<} z;?i#yRL)!^H3+AqQ6RkUb1~xu{+3WZi?obDJZX-oyF4P+BG>ntBS`S43naf}UqSW` z0yQ*UAbTZXr>0<7MrsXfAvRXX0gnDXn_B(hkNj&^Q)v=eNu|{ctx5XRu?jQ}Pp7o_NR2gp*gOG0|3oBS{A?Lz!ve0Dg*eqy7`o#A% ztCY5+U}p^NyY6>5E!ttnAF{bX*DSTpESx&Nle3ANVY~i0)e>EUhi0^drHl4wEEW}h z^L-)FBf?~+a(D&bb#^-ZXlMk!?_8ZEOlzeHr!p^?M#p2SnGJqFb$TUAr;ZZ*(b~*f z2>yrfr=ZIO7EAA3omgAx4`KlTn&IeAQS)$b!8x=$2i>mYa`rbh%aqPZ&MLqJ+X!If z#BYL>Q`Crdh#Wv=Q!x*G)Ay;fiY!h3x&XHJa#vQQ#UHv_8w8-IB`spW{n}C^JD&a0 zR2k-SMW7e(I$-lk8AeuD))2`oITJ=CeC`v7C7l!ug)~`iEqDQr^-zof6OtqVGL0LV ziXz?Sx8oN!fhxsY69*Hc#Ih2{V{shYun+GYe~5ne^)y=x zA1%x9?=HfFsWjsClrMBozWQJIiaU|^vNH=<4$H(B!&B`yqXMiUj|W9~EnGv$Qk;O_-e;EY*paw~(^ zDPbiQ1;Mj5s%)M1Ve{|=Sc_@Wv`fE%8$CV>{dUq4kQY$IBTRrCmRMXy4BCVT;USU& zv@9O8fK48sfIma+u2|DE5oSc2wu8+`A-phQ--^cc{eWw(_%l9pz8kIfqC%SSRi-cb zvrEVC#&3n|YQ~4o@2wtP9cwQW06 .section { + text-align: left; +} + +div.footer { + width: 940px; + margin: 20px auto 30px auto; + font-size: 14px; + color: #888; + text-align: right; +} + +div.footer a { + color: #888; +} + +p.caption { + font-family: inherit; + font-size: inherit; +} + + +div.relations { + display: none; +} + + +div.sphinxsidebar { + max-height: 100%; + overflow-y: auto; +} + +div.sphinxsidebar a { + color: #444; + text-decoration: none; + border-bottom: 1px dotted #999; +} + +div.sphinxsidebar a:hover { + border-bottom: 1px solid #999; +} + +div.sphinxsidebarwrapper { + padding: 18px 10px; +} + +div.sphinxsidebarwrapper p.logo { + padding: 0; + margin: -10px 0 0 0px; + text-align: center; +} + +div.sphinxsidebarwrapper h1.logo { + margin-top: -10px; + text-align: center; + margin-bottom: 5px; + text-align: left; +} + +div.sphinxsidebarwrapper h1.logo-name { + margin-top: 0px; +} + +div.sphinxsidebarwrapper p.blurb { + margin-top: 0; + font-style: normal; +} + +div.sphinxsidebar h3, +div.sphinxsidebar h4 { + font-family: Georgia, serif; + color: #444; + font-size: 24px; + font-weight: normal; + margin: 0 0 5px 0; + padding: 0; +} + +div.sphinxsidebar h4 { + font-size: 20px; +} + +div.sphinxsidebar h3 a { + color: #444; +} + +div.sphinxsidebar p.logo a, +div.sphinxsidebar h3 a, +div.sphinxsidebar p.logo a:hover, +div.sphinxsidebar h3 a:hover { + border: none; +} + +div.sphinxsidebar p { + color: #555; + margin: 10px 0; +} + +div.sphinxsidebar ul { + margin: 10px 0; + padding: 0; + color: #000; +} + +div.sphinxsidebar ul li.toctree-l1 > a { + font-size: 120%; +} + +div.sphinxsidebar ul li.toctree-l2 > a { + font-size: 110%; +} + +div.sphinxsidebar input { + border: 1px solid #CCC; + font-family: Georgia, serif; + font-size: 1em; +} + +div.sphinxsidebar #searchbox input[type="text"] { + width: 160px; +} + +div.sphinxsidebar .search > div { + display: table-cell; +} + +div.sphinxsidebar hr { + border: none; + height: 1px; + color: #AAA; + background: #AAA; + + text-align: left; + margin-left: 0; + width: 50%; +} + +div.sphinxsidebar .badge { + border-bottom: none; +} + +div.sphinxsidebar .badge:hover { + border-bottom: none; +} + +/* To address an issue with donation coming after search */ +div.sphinxsidebar h3.donation { + margin-top: 10px; +} + +/* -- body styles ----------------------------------------------------------- */ + +a { + color: #004B6B; + text-decoration: underline; +} + +a:hover { + color: #6D4100; + text-decoration: underline; +} + +div.body h1, +div.body h2, +div.body h3, +div.body h4, +div.body h5, +div.body h6 { + font-family: Georgia, serif; + font-weight: normal; + margin: 30px 0px 10px 0px; + padding: 0; +} + +div.body h1 { margin-top: 0; padding-top: 0; font-size: 240%; } +div.body h2 { font-size: 180%; } +div.body h3 { font-size: 150%; } +div.body h4 { font-size: 130%; } +div.body h5 { font-size: 100%; } +div.body h6 { font-size: 100%; } + +a.headerlink { + color: #DDD; + padding: 0 4px; + text-decoration: none; +} + +a.headerlink:hover { + color: #444; + background: #EAEAEA; +} + +div.body p, div.body dd, div.body li { + line-height: 1.4em; +} + +div.admonition { + margin: 20px 0px; + padding: 10px 30px; + background-color: #EEE; + border: 1px solid #CCC; +} + +div.admonition tt.xref, div.admonition code.xref, div.admonition a tt { + background-color: #FBFBFB; + border-bottom: 1px solid #fafafa; +} + +div.admonition p.admonition-title { + font-family: Georgia, serif; + font-weight: normal; + font-size: 24px; + margin: 0 0 10px 0; + padding: 0; + line-height: 1; +} + +div.admonition p.last { + margin-bottom: 0; +} + +div.highlight { + background-color: #fff; +} + +dt:target, .highlight { + background: #FAF3E8; +} + +div.warning { + background-color: #FCC; + border: 1px solid #FAA; +} + +div.danger { + background-color: #FCC; + border: 1px solid #FAA; + -moz-box-shadow: 2px 2px 4px #D52C2C; + -webkit-box-shadow: 2px 2px 4px #D52C2C; + box-shadow: 2px 2px 4px #D52C2C; +} + +div.error { + background-color: #FCC; + border: 1px solid #FAA; + -moz-box-shadow: 2px 2px 4px #D52C2C; + -webkit-box-shadow: 2px 2px 4px #D52C2C; + box-shadow: 2px 2px 4px #D52C2C; +} + +div.caution { + background-color: #FCC; + border: 1px solid #FAA; +} + +div.attention { + background-color: #FCC; + border: 1px solid #FAA; +} + +div.important { + background-color: #EEE; + border: 1px solid #CCC; +} + +div.note { + background-color: #EEE; + border: 1px solid #CCC; +} + +div.tip { + background-color: #EEE; + border: 1px solid #CCC; +} + +div.hint { + background-color: #EEE; + border: 1px solid #CCC; +} + +div.seealso { + background-color: #EEE; + border: 1px solid #CCC; +} + +div.topic { + background-color: #EEE; +} + +p.admonition-title { + display: inline; +} + +p.admonition-title:after { + content: ":"; +} + +pre, tt, code { + font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace; + font-size: 0.9em; +} + +.hll { + background-color: #FFC; + margin: 0 -12px; + padding: 0 12px; + display: block; +} + +img.screenshot { +} + +tt.descname, tt.descclassname, code.descname, code.descclassname { + font-size: 0.95em; +} + +tt.descname, code.descname { + padding-right: 0.08em; +} + +img.screenshot { + -moz-box-shadow: 2px 2px 4px #EEE; + -webkit-box-shadow: 2px 2px 4px #EEE; + box-shadow: 2px 2px 4px #EEE; +} + +table.docutils { + border: 1px solid #888; + -moz-box-shadow: 2px 2px 4px #EEE; + -webkit-box-shadow: 2px 2px 4px #EEE; + box-shadow: 2px 2px 4px #EEE; +} + +table.docutils td, table.docutils th { + border: 1px solid #888; + padding: 0.25em 0.7em; +} + +table.field-list, table.footnote { + border: none; + -moz-box-shadow: none; + -webkit-box-shadow: none; + box-shadow: none; +} + +table.footnote { + margin: 15px 0; + width: 100%; + border: 1px solid #EEE; + background: #FDFDFD; + font-size: 0.9em; +} + +table.footnote + table.footnote { + margin-top: -15px; + border-top: none; +} + +table.field-list th { + padding: 0 0.8em 0 0; +} + +table.field-list td { + padding: 0; +} + +table.field-list p { + margin-bottom: 0.8em; +} + +/* Cloned from + * https://github.com/sphinx-doc/sphinx/commit/ef60dbfce09286b20b7385333d63a60321784e68 + */ +.field-name { + -moz-hyphens: manual; + -ms-hyphens: manual; + -webkit-hyphens: manual; + hyphens: manual; +} + +table.footnote td.label { + width: .1px; + padding: 0.3em 0 0.3em 0.5em; +} + +table.footnote td { + padding: 0.3em 0.5em; +} + +dl { + margin-left: 0; + margin-right: 0; + margin-top: 0; + padding: 0; +} + +dl dd { + margin-left: 30px; +} + +blockquote { + margin: 0 0 0 30px; + padding: 0; +} + +ul, ol { + /* Matches the 30px from the narrow-screen "li > ul" selector below */ + margin: 10px 0 10px 30px; + padding: 0; +} + +pre { + background: #EEE; + padding: 7px 30px; + margin: 15px 0px; + line-height: 1.3em; +} + +div.viewcode-block:target { + background: #ffd; +} + +dl pre, blockquote pre, li pre { + margin-left: 0; + padding-left: 30px; +} + +tt, code { + background-color: #ecf0f3; + color: #222; + /* padding: 1px 2px; */ +} + +tt.xref, code.xref, a tt { + background-color: #FBFBFB; + border-bottom: 1px solid #fff; +} + +a.reference { + text-decoration: none; + border-bottom: 1px dotted #004B6B; +} + +/* Don't put an underline on images */ +a.image-reference, a.image-reference:hover { + border-bottom: none; +} + +a.reference:hover { + border-bottom: 1px solid #6D4100; +} + +a.footnote-reference { + text-decoration: none; + font-size: 0.7em; + vertical-align: top; + border-bottom: 1px dotted #004B6B; +} + +a.footnote-reference:hover { + border-bottom: 1px solid #6D4100; +} + +a:hover tt, a:hover code { + background: #EEE; +} + + +@media screen and (max-width: 870px) { + + div.sphinxsidebar { + display: none; + } + + div.document { + width: 100%; + + } + + div.documentwrapper { + margin-left: 0; + margin-top: 0; + margin-right: 0; + margin-bottom: 0; + } + + div.bodywrapper { + margin-top: 0; + margin-right: 0; + margin-bottom: 0; + margin-left: 0; + } + + ul { + margin-left: 0; + } + + li > ul { + /* Matches the 30px from the "ul, ol" selector above */ + margin-left: 30px; + } + + .document { + width: auto; + } + + .footer { + width: auto; + } + + .bodywrapper { + margin: 0; + } + + .footer { + width: auto; + } + + .github { + display: none; + } + + + +} + + + +@media screen and (max-width: 875px) { + + body { + margin: 0; + padding: 20px 30px; + } + + div.documentwrapper { + float: none; + background: #fff; + } + + div.sphinxsidebar { + display: block; + float: none; + width: 102.5%; + margin: 50px -30px -20px -30px; + padding: 10px 20px; + background: #333; + color: #FFF; + } + + div.sphinxsidebar h3, div.sphinxsidebar h4, div.sphinxsidebar p, + div.sphinxsidebar h3 a { + color: #fff; + } + + div.sphinxsidebar a { + color: #AAA; + } + + div.sphinxsidebar p.logo { + display: none; + } + + div.document { + width: 100%; + margin: 0; + } + + div.footer { + display: none; + } + + div.bodywrapper { + margin: 0; + } + + div.body { + min-height: 0; + padding: 0; + } + + .rtd_doc_footer { + display: none; + } + + .document { + width: auto; + } + + .footer { + width: auto; + } + + .footer { + width: auto; + } + + .github { + display: none; + } +} + + +/* misc. */ + +.revsys-inline { + display: none!important; +} + +/* Hide ugly table cell borders in ..bibliography:: directive output */ +table.docutils.citation, table.docutils.citation td, table.docutils.citation th { + border: none; + /* Below needed in some edge cases; if not applied, bottom shadows appear */ + -moz-box-shadow: none; + -webkit-box-shadow: none; + box-shadow: none; +} + + +/* relbar */ + +.related { + line-height: 30px; + width: 100%; + font-size: 0.9rem; +} + +.related.top { + border-bottom: 1px solid #EEE; + margin-bottom: 20px; +} + +.related.bottom { + border-top: 1px solid #EEE; +} + +.related ul { + padding: 0; + margin: 0; + list-style: none; +} + +.related li { + display: inline; +} + +nav#rellinks { + float: right; +} + +nav#rellinks li+li:before { + content: "|"; +} + +nav#breadcrumbs li+li:before { + content: "\00BB"; +} + +/* Hide certain items when printing */ +@media print { + div.related { + display: none; + } +} \ No newline at end of file diff --git a/docs/build/_static/basic.css b/docs/build/_static/basic.css new file mode 100644 index 0000000..4157edf --- /dev/null +++ b/docs/build/_static/basic.css @@ -0,0 +1,925 @@ +/* + * basic.css + * ~~~~~~~~~ + * + * Sphinx stylesheet -- basic theme. + * + * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +/* -- main layout ----------------------------------------------------------- */ + +div.clearer { + clear: both; +} + +div.section::after { + display: block; + content: ''; + clear: left; +} + +/* -- relbar ---------------------------------------------------------------- */ + +div.related { + width: 100%; + font-size: 90%; +} + +div.related h3 { + display: none; +} + +div.related ul { + margin: 0; + padding: 0 0 0 10px; + list-style: none; +} + +div.related li { + display: inline; +} + +div.related li.right { + float: right; + margin-right: 5px; +} + +/* -- sidebar --------------------------------------------------------------- */ + +div.sphinxsidebarwrapper { + padding: 10px 5px 0 10px; +} + +div.sphinxsidebar { + float: left; + width: 230px; + margin-left: -100%; + font-size: 90%; + word-wrap: break-word; + overflow-wrap : break-word; +} + +div.sphinxsidebar ul { + list-style: none; +} + +div.sphinxsidebar ul ul, +div.sphinxsidebar ul.want-points { + margin-left: 20px; + list-style: square; +} + +div.sphinxsidebar ul ul { + margin-top: 0; + margin-bottom: 0; +} + +div.sphinxsidebar form { + margin-top: 10px; +} + +div.sphinxsidebar input { + border: 1px solid #98dbcc; + font-family: sans-serif; + font-size: 1em; +} + +div.sphinxsidebar #searchbox form.search { + overflow: hidden; +} + +div.sphinxsidebar #searchbox input[type="text"] { + float: left; + width: 80%; + padding: 0.25em; + box-sizing: border-box; +} + +div.sphinxsidebar #searchbox input[type="submit"] { + float: left; + width: 20%; + border-left: none; + padding: 0.25em; + box-sizing: border-box; +} + + +img { + border: 0; + max-width: 100%; +} + +/* -- search page ----------------------------------------------------------- */ + +ul.search { + margin: 10px 0 0 20px; + padding: 0; +} + +ul.search li { + padding: 5px 0 5px 20px; + background-image: url(file.png); + background-repeat: no-repeat; + background-position: 0 7px; +} + +ul.search li a { + font-weight: bold; +} + +ul.search li p.context { + color: #888; + margin: 2px 0 0 30px; + text-align: left; +} + +ul.keywordmatches li.goodmatch a { + font-weight: bold; +} + +/* -- index page ------------------------------------------------------------ */ + +table.contentstable { + width: 90%; + margin-left: auto; + margin-right: auto; +} + +table.contentstable p.biglink { + line-height: 150%; +} + +a.biglink { + font-size: 1.3em; +} + +span.linkdescr { + font-style: italic; + padding-top: 5px; + font-size: 90%; +} + +/* -- general index --------------------------------------------------------- */ + +table.indextable { + width: 100%; +} + +table.indextable td { + text-align: left; + vertical-align: top; +} + +table.indextable ul { + margin-top: 0; + margin-bottom: 0; + list-style-type: none; +} + +table.indextable > tbody > tr > td > ul { + padding-left: 0em; +} + +table.indextable tr.pcap { + height: 10px; +} + +table.indextable tr.cap { + margin-top: 10px; + background-color: #f2f2f2; +} + +img.toggler { + margin-right: 3px; + margin-top: 3px; + cursor: pointer; +} + +div.modindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +div.genindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +/* -- domain module index --------------------------------------------------- */ + +table.modindextable td { + padding: 2px; + border-collapse: collapse; +} + +/* -- general body styles --------------------------------------------------- */ + +div.body { + min-width: inherit; + max-width: 800px; +} + +div.body p, div.body dd, div.body li, div.body blockquote { + -moz-hyphens: auto; + -ms-hyphens: auto; + -webkit-hyphens: auto; + hyphens: auto; +} + +a.headerlink { + visibility: hidden; +} + +a:visited { + color: #551A8B; +} + +h1:hover > a.headerlink, +h2:hover > a.headerlink, +h3:hover > a.headerlink, +h4:hover > a.headerlink, +h5:hover > a.headerlink, +h6:hover > a.headerlink, +dt:hover > a.headerlink, +caption:hover > a.headerlink, +p.caption:hover > a.headerlink, +div.code-block-caption:hover > a.headerlink { + visibility: visible; +} + +div.body p.caption { + text-align: inherit; +} + +div.body td { + text-align: left; +} + +.first { + margin-top: 0 !important; +} + +p.rubric { + margin-top: 30px; + font-weight: bold; +} + +img.align-left, figure.align-left, .figure.align-left, object.align-left { + clear: left; + float: left; + margin-right: 1em; +} + +img.align-right, figure.align-right, .figure.align-right, object.align-right { + clear: right; + float: right; + margin-left: 1em; +} + +img.align-center, figure.align-center, .figure.align-center, object.align-center { + display: block; + margin-left: auto; + margin-right: auto; +} + +img.align-default, figure.align-default, .figure.align-default { + display: block; + margin-left: auto; + margin-right: auto; +} + +.align-left { + text-align: left; +} + +.align-center { + text-align: center; +} + +.align-default { + text-align: center; +} + +.align-right { + text-align: right; +} + +/* -- sidebars -------------------------------------------------------------- */ + +div.sidebar, +aside.sidebar { + margin: 0 0 0.5em 1em; + border: 1px solid #ddb; + padding: 7px; + background-color: #ffe; + width: 40%; + float: right; + clear: right; + overflow-x: auto; +} + +p.sidebar-title { + font-weight: bold; +} + +nav.contents, +aside.topic, +div.admonition, div.topic, blockquote { + clear: left; +} + +/* -- topics ---------------------------------------------------------------- */ + +nav.contents, +aside.topic, +div.topic { + border: 1px solid #ccc; + padding: 7px; + margin: 10px 0 10px 0; +} + +p.topic-title { + font-size: 1.1em; + font-weight: bold; + margin-top: 10px; +} + +/* -- admonitions ----------------------------------------------------------- */ + +div.admonition { + margin-top: 10px; + margin-bottom: 10px; + padding: 7px; +} + +div.admonition dt { + font-weight: bold; +} + +p.admonition-title { + margin: 0px 10px 5px 0px; + font-weight: bold; +} + +div.body p.centered { + text-align: center; + margin-top: 25px; +} + +/* -- content of sidebars/topics/admonitions -------------------------------- */ + +div.sidebar > :last-child, +aside.sidebar > :last-child, +nav.contents > :last-child, +aside.topic > :last-child, +div.topic > :last-child, +div.admonition > :last-child { + margin-bottom: 0; +} + +div.sidebar::after, +aside.sidebar::after, +nav.contents::after, +aside.topic::after, +div.topic::after, +div.admonition::after, +blockquote::after { + display: block; + content: ''; + clear: both; +} + +/* -- tables ---------------------------------------------------------------- */ + +table.docutils { + margin-top: 10px; + margin-bottom: 10px; + border: 0; + border-collapse: collapse; +} + +table.align-center { + margin-left: auto; + margin-right: auto; +} + +table.align-default { + margin-left: auto; + margin-right: auto; +} + +table caption span.caption-number { + font-style: italic; +} + +table caption span.caption-text { +} + +table.docutils td, table.docutils th { + padding: 1px 8px 1px 5px; + border-top: 0; + border-left: 0; + border-right: 0; + border-bottom: 1px solid #aaa; +} + +th { + text-align: left; + padding-right: 5px; +} + +table.citation { + border-left: solid 1px gray; + margin-left: 1px; +} + +table.citation td { + border-bottom: none; +} + +th > :first-child, +td > :first-child { + margin-top: 0px; +} + +th > :last-child, +td > :last-child { + margin-bottom: 0px; +} + +/* -- figures --------------------------------------------------------------- */ + +div.figure, figure { + margin: 0.5em; + padding: 0.5em; +} + +div.figure p.caption, figcaption { + padding: 0.3em; +} + +div.figure p.caption span.caption-number, +figcaption span.caption-number { + font-style: italic; +} + +div.figure p.caption span.caption-text, +figcaption span.caption-text { +} + +/* -- field list styles ----------------------------------------------------- */ + +table.field-list td, table.field-list th { + border: 0 !important; +} + +.field-list ul { + margin: 0; + padding-left: 1em; +} + +.field-list p { + margin: 0; +} + +.field-name { + -moz-hyphens: manual; + -ms-hyphens: manual; + -webkit-hyphens: manual; + hyphens: manual; +} + +/* -- hlist styles ---------------------------------------------------------- */ + +table.hlist { + margin: 1em 0; +} + +table.hlist td { + vertical-align: top; +} + +/* -- object description styles --------------------------------------------- */ + +.sig { + font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace; +} + +.sig-name, code.descname { + background-color: transparent; + font-weight: bold; +} + +.sig-name { + font-size: 1.1em; +} + +code.descname { + font-size: 1.2em; +} + +.sig-prename, code.descclassname { + background-color: transparent; +} + +.optional { + font-size: 1.3em; +} + +.sig-paren { + font-size: larger; +} + +.sig-param.n { + font-style: italic; +} + +/* C++ specific styling */ + +.sig-inline.c-texpr, +.sig-inline.cpp-texpr { + font-family: unset; +} + +.sig.c .k, .sig.c .kt, +.sig.cpp .k, .sig.cpp .kt { + color: #0033B3; +} + +.sig.c .m, +.sig.cpp .m { + color: #1750EB; +} + +.sig.c .s, .sig.c .sc, +.sig.cpp .s, .sig.cpp .sc { + color: #067D17; +} + + +/* -- other body styles ----------------------------------------------------- */ + +ol.arabic { + list-style: decimal; +} + +ol.loweralpha { + list-style: lower-alpha; +} + +ol.upperalpha { + list-style: upper-alpha; +} + +ol.lowerroman { + list-style: lower-roman; +} + +ol.upperroman { + list-style: upper-roman; +} + +:not(li) > ol > li:first-child > :first-child, +:not(li) > ul > li:first-child > :first-child { + margin-top: 0px; +} + +:not(li) > ol > li:last-child > :last-child, +:not(li) > ul > li:last-child > :last-child { + margin-bottom: 0px; +} + +ol.simple ol p, +ol.simple ul p, +ul.simple ol p, +ul.simple ul p { + margin-top: 0; +} + +ol.simple > li:not(:first-child) > p, +ul.simple > li:not(:first-child) > p { + margin-top: 0; +} + +ol.simple p, +ul.simple p { + margin-bottom: 0; +} + +aside.footnote > span, +div.citation > span { + float: left; +} +aside.footnote > span:last-of-type, +div.citation > span:last-of-type { + padding-right: 0.5em; +} +aside.footnote > p { + margin-left: 2em; +} +div.citation > p { + margin-left: 4em; +} +aside.footnote > p:last-of-type, +div.citation > p:last-of-type { + margin-bottom: 0em; +} +aside.footnote > p:last-of-type:after, +div.citation > p:last-of-type:after { + content: ""; + clear: both; +} + +dl.field-list { + display: grid; + grid-template-columns: fit-content(30%) auto; +} + +dl.field-list > dt { + font-weight: bold; + word-break: break-word; + padding-left: 0.5em; + padding-right: 5px; +} + +dl.field-list > dd { + padding-left: 0.5em; + margin-top: 0em; + margin-left: 0em; + margin-bottom: 0em; +} + +dl { + margin-bottom: 15px; +} + +dd > :first-child { + margin-top: 0px; +} + +dd ul, dd table { + margin-bottom: 10px; +} + +dd { + margin-top: 3px; + margin-bottom: 10px; + margin-left: 30px; +} + +.sig dd { + margin-top: 0px; + margin-bottom: 0px; +} + +.sig dl { + margin-top: 0px; + margin-bottom: 0px; +} + +dl > dd:last-child, +dl > dd:last-child > :last-child { + margin-bottom: 0; +} + +dt:target, span.highlighted { + background-color: #fbe54e; +} + +rect.highlighted { + fill: #fbe54e; +} + +dl.glossary dt { + font-weight: bold; + font-size: 1.1em; +} + +.versionmodified { + font-style: italic; +} + +.system-message { + background-color: #fda; + padding: 5px; + border: 3px solid red; +} + +.footnote:target { + background-color: #ffa; +} + +.line-block { + display: block; + margin-top: 1em; + margin-bottom: 1em; +} + +.line-block .line-block { + margin-top: 0; + margin-bottom: 0; + margin-left: 1.5em; +} + +.guilabel, .menuselection { + font-family: sans-serif; +} + +.accelerator { + text-decoration: underline; +} + +.classifier { + font-style: oblique; +} + +.classifier:before { + font-style: normal; + margin: 0 0.5em; + content: ":"; + display: inline-block; +} + +abbr, acronym { + border-bottom: dotted 1px; + cursor: help; +} + +.translated { + background-color: rgba(207, 255, 207, 0.2) +} + +.untranslated { + background-color: rgba(255, 207, 207, 0.2) +} + +/* -- code displays --------------------------------------------------------- */ + +pre { + overflow: auto; + overflow-y: hidden; /* fixes display issues on Chrome browsers */ +} + +pre, div[class*="highlight-"] { + clear: both; +} + +span.pre { + -moz-hyphens: none; + -ms-hyphens: none; + -webkit-hyphens: none; + hyphens: none; + white-space: nowrap; +} + +div[class*="highlight-"] { + margin: 1em 0; +} + +td.linenos pre { + border: 0; + background-color: transparent; + color: #aaa; +} + +table.highlighttable { + display: block; +} + +table.highlighttable tbody { + display: block; +} + +table.highlighttable tr { + display: flex; +} + +table.highlighttable td { + margin: 0; + padding: 0; +} + +table.highlighttable td.linenos { + padding-right: 0.5em; +} + +table.highlighttable td.code { + flex: 1; + overflow: hidden; +} + +.highlight .hll { + display: block; +} + +div.highlight pre, +table.highlighttable pre { + margin: 0; +} + +div.code-block-caption + div { + margin-top: 0; +} + +div.code-block-caption { + margin-top: 1em; + padding: 2px 5px; + font-size: small; +} + +div.code-block-caption code { + background-color: transparent; +} + +table.highlighttable td.linenos, +span.linenos, +div.highlight span.gp { /* gp: Generic.Prompt */ + user-select: none; + -webkit-user-select: text; /* Safari fallback only */ + -webkit-user-select: none; /* Chrome/Safari */ + -moz-user-select: none; /* Firefox */ + -ms-user-select: none; /* IE10+ */ +} + +div.code-block-caption span.caption-number { + padding: 0.1em 0.3em; + font-style: italic; +} + +div.code-block-caption span.caption-text { +} + +div.literal-block-wrapper { + margin: 1em 0; +} + +code.xref, a code { + background-color: transparent; + font-weight: bold; +} + +h1 code, h2 code, h3 code, h4 code, h5 code, h6 code { + background-color: transparent; +} + +.viewcode-link { + float: right; +} + +.viewcode-back { + float: right; + font-family: sans-serif; +} + +div.viewcode-block:target { + margin: -1px -10px; + padding: 0 10px; +} + +/* -- math display ---------------------------------------------------------- */ + +img.math { + vertical-align: middle; +} + +div.body div.math p { + text-align: center; +} + +span.eqno { + float: right; +} + +span.eqno a.headerlink { + position: absolute; + z-index: 1; +} + +div.math:hover a.headerlink { + visibility: visible; +} + +/* -- printout stylesheet --------------------------------------------------- */ + +@media print { + div.document, + div.documentwrapper, + div.bodywrapper { + margin: 0 !important; + width: 100%; + } + + div.sphinxsidebar, + div.related, + div.footer, + #top-link { + display: none; + } +} \ No newline at end of file diff --git a/docs/build/_static/custom.css b/docs/build/_static/custom.css new file mode 100644 index 0000000..2a924f1 --- /dev/null +++ b/docs/build/_static/custom.css @@ -0,0 +1 @@ +/* This file intentionally left blank. */ diff --git a/docs/build/_static/doctools.js b/docs/build/_static/doctools.js new file mode 100644 index 0000000..d06a71d --- /dev/null +++ b/docs/build/_static/doctools.js @@ -0,0 +1,156 @@ +/* + * doctools.js + * ~~~~~~~~~~~ + * + * Base JavaScript utilities for all Sphinx HTML documentation. + * + * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ +"use strict"; + +const BLACKLISTED_KEY_CONTROL_ELEMENTS = new Set([ + "TEXTAREA", + "INPUT", + "SELECT", + "BUTTON", +]); + +const _ready = (callback) => { + if (document.readyState !== "loading") { + callback(); + } else { + document.addEventListener("DOMContentLoaded", callback); + } +}; + +/** + * Small JavaScript module for the documentation. + */ +const Documentation = { + init: () => { + Documentation.initDomainIndexTable(); + Documentation.initOnKeyListeners(); + }, + + /** + * i18n support + */ + TRANSLATIONS: {}, + PLURAL_EXPR: (n) => (n === 1 ? 0 : 1), + LOCALE: "unknown", + + // gettext and ngettext don't access this so that the functions + // can safely bound to a different name (_ = Documentation.gettext) + gettext: (string) => { + const translated = Documentation.TRANSLATIONS[string]; + switch (typeof translated) { + case "undefined": + return string; // no translation + case "string": + return translated; // translation exists + default: + return translated[0]; // (singular, plural) translation tuple exists + } + }, + + ngettext: (singular, plural, n) => { + const translated = Documentation.TRANSLATIONS[singular]; + if (typeof translated !== "undefined") + return translated[Documentation.PLURAL_EXPR(n)]; + return n === 1 ? singular : plural; + }, + + addTranslations: (catalog) => { + Object.assign(Documentation.TRANSLATIONS, catalog.messages); + Documentation.PLURAL_EXPR = new Function( + "n", + `return (${catalog.plural_expr})` + ); + Documentation.LOCALE = catalog.locale; + }, + + /** + * helper function to focus on search bar + */ + focusSearchBar: () => { + document.querySelectorAll("input[name=q]")[0]?.focus(); + }, + + /** + * Initialise the domain index toggle buttons + */ + initDomainIndexTable: () => { + const toggler = (el) => { + const idNumber = el.id.substr(7); + const toggledRows = document.querySelectorAll(`tr.cg-${idNumber}`); + if (el.src.substr(-9) === "minus.png") { + el.src = `${el.src.substr(0, el.src.length - 9)}plus.png`; + toggledRows.forEach((el) => (el.style.display = "none")); + } else { + el.src = `${el.src.substr(0, el.src.length - 8)}minus.png`; + toggledRows.forEach((el) => (el.style.display = "")); + } + }; + + const togglerElements = document.querySelectorAll("img.toggler"); + togglerElements.forEach((el) => + el.addEventListener("click", (event) => toggler(event.currentTarget)) + ); + togglerElements.forEach((el) => (el.style.display = "")); + if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) togglerElements.forEach(toggler); + }, + + initOnKeyListeners: () => { + // only install a listener if it is really needed + if ( + !DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS && + !DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS + ) + return; + + document.addEventListener("keydown", (event) => { + // bail for input elements + if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return; + // bail with special keys + if (event.altKey || event.ctrlKey || event.metaKey) return; + + if (!event.shiftKey) { + switch (event.key) { + case "ArrowLeft": + if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break; + + const prevLink = document.querySelector('link[rel="prev"]'); + if (prevLink && prevLink.href) { + window.location.href = prevLink.href; + event.preventDefault(); + } + break; + case "ArrowRight": + if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break; + + const nextLink = document.querySelector('link[rel="next"]'); + if (nextLink && nextLink.href) { + window.location.href = nextLink.href; + event.preventDefault(); + } + break; + } + } + + // some keyboard layouts may need Shift to get / + switch (event.key) { + case "/": + if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) break; + Documentation.focusSearchBar(); + event.preventDefault(); + } + }); + }, +}; + +// quick alias for translations +const _ = Documentation.gettext; + +_ready(Documentation.init); diff --git a/docs/build/_static/documentation_options.js b/docs/build/_static/documentation_options.js new file mode 100644 index 0000000..010ec37 --- /dev/null +++ b/docs/build/_static/documentation_options.js @@ -0,0 +1,13 @@ +const DOCUMENTATION_OPTIONS = { + VERSION: '"0.0.1"', + LANGUAGE: 'en', + COLLAPSE_INDEX: false, + BUILDER: 'html', + FILE_SUFFIX: '.html', + LINK_SUFFIX: '.html', + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '.txt', + NAVIGATION_WITH_KEYS: false, + SHOW_SEARCH_SUMMARY: true, + ENABLE_SEARCH_SHORTCUTS: true, +}; \ No newline at end of file diff --git a/docs/build/_static/file.png b/docs/build/_static/file.png new file mode 100644 index 0000000000000000000000000000000000000000..a858a410e4faa62ce324d814e4b816fff83a6fb3 GIT binary patch literal 286 zcmV+(0pb3MP)s`hMrGg#P~ix$^RISR_I47Y|r1 z_CyJOe}D1){SET-^Amu_i71Lt6eYfZjRyw@I6OQAIXXHDfiX^GbOlHe=Ae4>0m)d(f|Me07*qoM6N<$f}vM^LjV8( literal 0 HcmV?d00001 diff --git a/docs/build/_static/language_data.js b/docs/build/_static/language_data.js new file mode 100644 index 0000000..250f566 --- /dev/null +++ b/docs/build/_static/language_data.js @@ -0,0 +1,199 @@ +/* + * language_data.js + * ~~~~~~~~~~~~~~~~ + * + * This script contains the language-specific data used by searchtools.js, + * namely the list of stopwords, stemmer, scorer and splitter. + * + * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +var stopwords = ["a", "and", "are", "as", "at", "be", "but", "by", "for", "if", "in", "into", "is", "it", "near", "no", "not", "of", "on", "or", "such", "that", "the", "their", "then", "there", "these", "they", "this", "to", "was", "will", "with"]; + + +/* Non-minified version is copied as a separate JS file, is available */ + +/** + * Porter Stemmer + */ +var Stemmer = function() { + + var step2list = { + ational: 'ate', + tional: 'tion', + enci: 'ence', + anci: 'ance', + izer: 'ize', + bli: 'ble', + alli: 'al', + entli: 'ent', + eli: 'e', + ousli: 'ous', + ization: 'ize', + ation: 'ate', + ator: 'ate', + alism: 'al', + iveness: 'ive', + fulness: 'ful', + ousness: 'ous', + aliti: 'al', + iviti: 'ive', + biliti: 'ble', + logi: 'log' + }; + + var step3list = { + icate: 'ic', + ative: '', + alize: 'al', + iciti: 'ic', + ical: 'ic', + ful: '', + ness: '' + }; + + var c = "[^aeiou]"; // consonant + var v = "[aeiouy]"; // vowel + var C = c + "[^aeiouy]*"; // consonant sequence + var V = v + "[aeiou]*"; // vowel sequence + + var mgr0 = "^(" + C + ")?" + V + C; // [C]VC... is m>0 + var meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$"; // [C]VC[V] is m=1 + var mgr1 = "^(" + C + ")?" + V + C + V + C; // [C]VCVC... is m>1 + var s_v = "^(" + C + ")?" + v; // vowel in stem + + this.stemWord = function (w) { + var stem; + var suffix; + var firstch; + var origword = w; + + if (w.length < 3) + return w; + + var re; + var re2; + var re3; + var re4; + + firstch = w.substr(0,1); + if (firstch == "y") + w = firstch.toUpperCase() + w.substr(1); + + // Step 1a + re = /^(.+?)(ss|i)es$/; + re2 = /^(.+?)([^s])s$/; + + if (re.test(w)) + w = w.replace(re,"$1$2"); + else if (re2.test(w)) + w = w.replace(re2,"$1$2"); + + // Step 1b + re = /^(.+?)eed$/; + re2 = /^(.+?)(ed|ing)$/; + if (re.test(w)) { + var fp = re.exec(w); + re = new RegExp(mgr0); + if (re.test(fp[1])) { + re = /.$/; + w = w.replace(re,""); + } + } + else if (re2.test(w)) { + var fp = re2.exec(w); + stem = fp[1]; + re2 = new RegExp(s_v); + if (re2.test(stem)) { + w = stem; + re2 = /(at|bl|iz)$/; + re3 = new RegExp("([^aeiouylsz])\\1$"); + re4 = new RegExp("^" + C + v + "[^aeiouwxy]$"); + if (re2.test(w)) + w = w + "e"; + else if (re3.test(w)) { + re = /.$/; + w = w.replace(re,""); + } + else if (re4.test(w)) + w = w + "e"; + } + } + + // Step 1c + re = /^(.+?)y$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(s_v); + if (re.test(stem)) + w = stem + "i"; + } + + // Step 2 + re = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + suffix = fp[2]; + re = new RegExp(mgr0); + if (re.test(stem)) + w = stem + step2list[suffix]; + } + + // Step 3 + re = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + suffix = fp[2]; + re = new RegExp(mgr0); + if (re.test(stem)) + w = stem + step3list[suffix]; + } + + // Step 4 + re = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/; + re2 = /^(.+?)(s|t)(ion)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(mgr1); + if (re.test(stem)) + w = stem; + } + else if (re2.test(w)) { + var fp = re2.exec(w); + stem = fp[1] + fp[2]; + re2 = new RegExp(mgr1); + if (re2.test(stem)) + w = stem; + } + + // Step 5 + re = /^(.+?)e$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(mgr1); + re2 = new RegExp(meq1); + re3 = new RegExp("^" + C + v + "[^aeiouwxy]$"); + if (re.test(stem) || (re2.test(stem) && !(re3.test(stem)))) + w = stem; + } + re = /ll$/; + re2 = new RegExp(mgr1); + if (re.test(w) && re2.test(w)) { + re = /.$/; + w = w.replace(re,""); + } + + // and turn initial Y back to y + if (firstch == "y") + w = firstch.toLowerCase() + w.substr(1); + return w; + } +} + diff --git a/docs/build/_static/minus.png b/docs/build/_static/minus.png new file mode 100644 index 0000000000000000000000000000000000000000..d96755fdaf8bb2214971e0db9c1fd3077d7c419d GIT binary patch literal 90 zcmeAS@N?(olHy`uVBq!ia0vp^+#t*WBp7;*Yy1LIik>cxAr*|t7R?Mi>2?kWtu=nj kDsEF_5m^0CR;1wuP-*O&G^0G}KYk!hp00i_>zopr08q^qX#fBK literal 0 HcmV?d00001 diff --git a/docs/build/_static/plus.png b/docs/build/_static/plus.png new file mode 100644 index 0000000000000000000000000000000000000000..7107cec93a979b9a5f64843235a16651d563ce2d GIT binary patch literal 90 zcmeAS@N?(olHy`uVBq!ia0vp^+#t*WBp7;*Yy1LIik>cxAr*|t7R?Mi>2?kWtu>-2 m3q%Vub%g%s<8sJhVPMczOq}xhg9DJoz~JfX=d#Wzp$Pyb1r*Kz literal 0 HcmV?d00001 diff --git a/docs/build/_static/pygments.css b/docs/build/_static/pygments.css new file mode 100644 index 0000000..04a4174 --- /dev/null +++ b/docs/build/_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/build/_static/searchtools.js b/docs/build/_static/searchtools.js new file mode 100644 index 0000000..7918c3f --- /dev/null +++ b/docs/build/_static/searchtools.js @@ -0,0 +1,574 @@ +/* + * searchtools.js + * ~~~~~~~~~~~~~~~~ + * + * Sphinx JavaScript utilities for the full-text search. + * + * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ +"use strict"; + +/** + * Simple result scoring code. + */ +if (typeof Scorer === "undefined") { + var Scorer = { + // Implement the following function to further tweak the score for each result + // The function takes a result array [docname, title, anchor, descr, score, filename] + // and returns the new score. + /* + score: result => { + const [docname, title, anchor, descr, score, filename] = result + return score + }, + */ + + // query matches the full name of an object + objNameMatch: 11, + // or matches in the last dotted part of the object name + objPartialMatch: 6, + // Additive scores depending on the priority of the object + objPrio: { + 0: 15, // used to be importantResults + 1: 5, // used to be objectResults + 2: -5, // used to be unimportantResults + }, + // Used when the priority is not in the mapping. + objPrioDefault: 0, + + // query found in title + title: 15, + partialTitle: 7, + // query found in terms + term: 5, + partialTerm: 2, + }; +} + +const _removeChildren = (element) => { + while (element && element.lastChild) element.removeChild(element.lastChild); +}; + +/** + * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions#escaping + */ +const _escapeRegExp = (string) => + string.replace(/[.*+\-?^${}()|[\]\\]/g, "\\$&"); // $& means the whole matched string + +const _displayItem = (item, searchTerms, highlightTerms) => { + const docBuilder = DOCUMENTATION_OPTIONS.BUILDER; + const docFileSuffix = DOCUMENTATION_OPTIONS.FILE_SUFFIX; + const docLinkSuffix = DOCUMENTATION_OPTIONS.LINK_SUFFIX; + const showSearchSummary = DOCUMENTATION_OPTIONS.SHOW_SEARCH_SUMMARY; + const contentRoot = document.documentElement.dataset.content_root; + + const [docName, title, anchor, descr, score, _filename] = item; + + let listItem = document.createElement("li"); + let requestUrl; + let linkUrl; + if (docBuilder === "dirhtml") { + // dirhtml builder + let dirname = docName + "/"; + if (dirname.match(/\/index\/$/)) + dirname = dirname.substring(0, dirname.length - 6); + else if (dirname === "index/") dirname = ""; + requestUrl = contentRoot + dirname; + linkUrl = requestUrl; + } else { + // normal html builders + requestUrl = contentRoot + docName + docFileSuffix; + linkUrl = docName + docLinkSuffix; + } + let linkEl = listItem.appendChild(document.createElement("a")); + linkEl.href = linkUrl + anchor; + linkEl.dataset.score = score; + linkEl.innerHTML = title; + if (descr) { + listItem.appendChild(document.createElement("span")).innerHTML = + " (" + descr + ")"; + // highlight search terms in the description + if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js + highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted")); + } + else if (showSearchSummary) + fetch(requestUrl) + .then((responseData) => responseData.text()) + .then((data) => { + if (data) + listItem.appendChild( + Search.makeSearchSummary(data, searchTerms) + ); + // highlight search terms in the summary + if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js + highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted")); + }); + Search.output.appendChild(listItem); +}; +const _finishSearch = (resultCount) => { + Search.stopPulse(); + Search.title.innerText = _("Search Results"); + if (!resultCount) + Search.status.innerText = Documentation.gettext( + "Your search did not match any documents. Please make sure that all words are spelled correctly and that you've selected enough categories." + ); + else + Search.status.innerText = _( + `Search finished, found ${resultCount} page(s) matching the search query.` + ); +}; +const _displayNextItem = ( + results, + resultCount, + searchTerms, + highlightTerms, +) => { + // results left, load the summary and display it + // this is intended to be dynamic (don't sub resultsCount) + if (results.length) { + _displayItem(results.pop(), searchTerms, highlightTerms); + setTimeout( + () => _displayNextItem(results, resultCount, searchTerms, highlightTerms), + 5 + ); + } + // search finished, update title and status message + else _finishSearch(resultCount); +}; + +/** + * Default splitQuery function. Can be overridden in ``sphinx.search`` with a + * custom function per language. + * + * The regular expression works by splitting the string on consecutive characters + * that are not Unicode letters, numbers, underscores, or emoji characters. + * This is the same as ``\W+`` in Python, preserving the surrogate pair area. + */ +if (typeof splitQuery === "undefined") { + var splitQuery = (query) => query + .split(/[^\p{Letter}\p{Number}_\p{Emoji_Presentation}]+/gu) + .filter(term => term) // remove remaining empty strings +} + +/** + * Search Module + */ +const Search = { + _index: null, + _queued_query: null, + _pulse_status: -1, + + htmlToText: (htmlString) => { + const htmlElement = new DOMParser().parseFromString(htmlString, 'text/html'); + htmlElement.querySelectorAll(".headerlink").forEach((el) => { el.remove() }); + const docContent = htmlElement.querySelector('[role="main"]'); + if (docContent !== undefined) return docContent.textContent; + console.warn( + "Content block not found. Sphinx search tries to obtain it via '[role=main]'. Could you check your theme or template." + ); + return ""; + }, + + init: () => { + const query = new URLSearchParams(window.location.search).get("q"); + document + .querySelectorAll('input[name="q"]') + .forEach((el) => (el.value = query)); + if (query) Search.performSearch(query); + }, + + loadIndex: (url) => + (document.body.appendChild(document.createElement("script")).src = url), + + setIndex: (index) => { + Search._index = index; + if (Search._queued_query !== null) { + const query = Search._queued_query; + Search._queued_query = null; + Search.query(query); + } + }, + + hasIndex: () => Search._index !== null, + + deferQuery: (query) => (Search._queued_query = query), + + stopPulse: () => (Search._pulse_status = -1), + + startPulse: () => { + if (Search._pulse_status >= 0) return; + + const pulse = () => { + Search._pulse_status = (Search._pulse_status + 1) % 4; + Search.dots.innerText = ".".repeat(Search._pulse_status); + if (Search._pulse_status >= 0) window.setTimeout(pulse, 500); + }; + pulse(); + }, + + /** + * perform a search for something (or wait until index is loaded) + */ + performSearch: (query) => { + // create the required interface elements + const searchText = document.createElement("h2"); + searchText.textContent = _("Searching"); + const searchSummary = document.createElement("p"); + searchSummary.classList.add("search-summary"); + searchSummary.innerText = ""; + const searchList = document.createElement("ul"); + searchList.classList.add("search"); + + const out = document.getElementById("search-results"); + Search.title = out.appendChild(searchText); + Search.dots = Search.title.appendChild(document.createElement("span")); + Search.status = out.appendChild(searchSummary); + Search.output = out.appendChild(searchList); + + const searchProgress = document.getElementById("search-progress"); + // Some themes don't use the search progress node + if (searchProgress) { + searchProgress.innerText = _("Preparing search..."); + } + Search.startPulse(); + + // index already loaded, the browser was quick! + if (Search.hasIndex()) Search.query(query); + else Search.deferQuery(query); + }, + + /** + * execute search (requires search index to be loaded) + */ + query: (query) => { + const filenames = Search._index.filenames; + const docNames = Search._index.docnames; + const titles = Search._index.titles; + const allTitles = Search._index.alltitles; + const indexEntries = Search._index.indexentries; + + // stem the search terms and add them to the correct list + const stemmer = new Stemmer(); + const searchTerms = new Set(); + const excludedTerms = new Set(); + const highlightTerms = new Set(); + const objectTerms = new Set(splitQuery(query.toLowerCase().trim())); + splitQuery(query.trim()).forEach((queryTerm) => { + const queryTermLower = queryTerm.toLowerCase(); + + // maybe skip this "word" + // stopwords array is from language_data.js + if ( + stopwords.indexOf(queryTermLower) !== -1 || + queryTerm.match(/^\d+$/) + ) + return; + + // stem the word + let word = stemmer.stemWord(queryTermLower); + // select the correct list + if (word[0] === "-") excludedTerms.add(word.substr(1)); + else { + searchTerms.add(word); + highlightTerms.add(queryTermLower); + } + }); + + if (SPHINX_HIGHLIGHT_ENABLED) { // set in sphinx_highlight.js + localStorage.setItem("sphinx_highlight_terms", [...highlightTerms].join(" ")) + } + + // console.debug("SEARCH: searching for:"); + // console.info("required: ", [...searchTerms]); + // console.info("excluded: ", [...excludedTerms]); + + // array of [docname, title, anchor, descr, score, filename] + let results = []; + _removeChildren(document.getElementById("search-progress")); + + const queryLower = query.toLowerCase(); + for (const [title, foundTitles] of Object.entries(allTitles)) { + if (title.toLowerCase().includes(queryLower) && (queryLower.length >= title.length/2)) { + for (const [file, id] of foundTitles) { + let score = Math.round(100 * queryLower.length / title.length) + results.push([ + docNames[file], + titles[file] !== title ? `${titles[file]} > ${title}` : title, + id !== null ? "#" + id : "", + null, + score, + filenames[file], + ]); + } + } + } + + // search for explicit entries in index directives + for (const [entry, foundEntries] of Object.entries(indexEntries)) { + if (entry.includes(queryLower) && (queryLower.length >= entry.length/2)) { + for (const [file, id] of foundEntries) { + let score = Math.round(100 * queryLower.length / entry.length) + results.push([ + docNames[file], + titles[file], + id ? "#" + id : "", + null, + score, + filenames[file], + ]); + } + } + } + + // lookup as object + objectTerms.forEach((term) => + results.push(...Search.performObjectSearch(term, objectTerms)) + ); + + // lookup as search terms in fulltext + results.push(...Search.performTermsSearch(searchTerms, excludedTerms)); + + // let the scorer override scores with a custom scoring function + if (Scorer.score) results.forEach((item) => (item[4] = Scorer.score(item))); + + // now sort the results by score (in opposite order of appearance, since the + // display function below uses pop() to retrieve items) and then + // alphabetically + results.sort((a, b) => { + const leftScore = a[4]; + const rightScore = b[4]; + if (leftScore === rightScore) { + // same score: sort alphabetically + const leftTitle = a[1].toLowerCase(); + const rightTitle = b[1].toLowerCase(); + if (leftTitle === rightTitle) return 0; + return leftTitle > rightTitle ? -1 : 1; // inverted is intentional + } + return leftScore > rightScore ? 1 : -1; + }); + + // remove duplicate search results + // note the reversing of results, so that in the case of duplicates, the highest-scoring entry is kept + let seen = new Set(); + results = results.reverse().reduce((acc, result) => { + let resultStr = result.slice(0, 4).concat([result[5]]).map(v => String(v)).join(','); + if (!seen.has(resultStr)) { + acc.push(result); + seen.add(resultStr); + } + return acc; + }, []); + + results = results.reverse(); + + // for debugging + //Search.lastresults = results.slice(); // a copy + // console.info("search results:", Search.lastresults); + + // print the results + _displayNextItem(results, results.length, searchTerms, highlightTerms); + }, + + /** + * search for object names + */ + performObjectSearch: (object, objectTerms) => { + const filenames = Search._index.filenames; + const docNames = Search._index.docnames; + const objects = Search._index.objects; + const objNames = Search._index.objnames; + const titles = Search._index.titles; + + const results = []; + + const objectSearchCallback = (prefix, match) => { + const name = match[4] + const fullname = (prefix ? prefix + "." : "") + name; + const fullnameLower = fullname.toLowerCase(); + if (fullnameLower.indexOf(object) < 0) return; + + let score = 0; + const parts = fullnameLower.split("."); + + // check for different match types: exact matches of full name or + // "last name" (i.e. last dotted part) + if (fullnameLower === object || parts.slice(-1)[0] === object) + score += Scorer.objNameMatch; + else if (parts.slice(-1)[0].indexOf(object) > -1) + score += Scorer.objPartialMatch; // matches in last name + + const objName = objNames[match[1]][2]; + const title = titles[match[0]]; + + // If more than one term searched for, we require other words to be + // found in the name/title/description + const otherTerms = new Set(objectTerms); + otherTerms.delete(object); + if (otherTerms.size > 0) { + const haystack = `${prefix} ${name} ${objName} ${title}`.toLowerCase(); + if ( + [...otherTerms].some((otherTerm) => haystack.indexOf(otherTerm) < 0) + ) + return; + } + + let anchor = match[3]; + if (anchor === "") anchor = fullname; + else if (anchor === "-") anchor = objNames[match[1]][1] + "-" + fullname; + + const descr = objName + _(", in ") + title; + + // add custom score for some objects according to scorer + if (Scorer.objPrio.hasOwnProperty(match[2])) + score += Scorer.objPrio[match[2]]; + else score += Scorer.objPrioDefault; + + results.push([ + docNames[match[0]], + fullname, + "#" + anchor, + descr, + score, + filenames[match[0]], + ]); + }; + Object.keys(objects).forEach((prefix) => + objects[prefix].forEach((array) => + objectSearchCallback(prefix, array) + ) + ); + return results; + }, + + /** + * search for full-text terms in the index + */ + performTermsSearch: (searchTerms, excludedTerms) => { + // prepare search + const terms = Search._index.terms; + const titleTerms = Search._index.titleterms; + const filenames = Search._index.filenames; + const docNames = Search._index.docnames; + const titles = Search._index.titles; + + const scoreMap = new Map(); + const fileMap = new Map(); + + // perform the search on the required terms + searchTerms.forEach((word) => { + const files = []; + const arr = [ + { files: terms[word], score: Scorer.term }, + { files: titleTerms[word], score: Scorer.title }, + ]; + // add support for partial matches + if (word.length > 2) { + const escapedWord = _escapeRegExp(word); + Object.keys(terms).forEach((term) => { + if (term.match(escapedWord) && !terms[word]) + arr.push({ files: terms[term], score: Scorer.partialTerm }); + }); + Object.keys(titleTerms).forEach((term) => { + if (term.match(escapedWord) && !titleTerms[word]) + arr.push({ files: titleTerms[word], score: Scorer.partialTitle }); + }); + } + + // no match but word was a required one + if (arr.every((record) => record.files === undefined)) return; + + // found search word in contents + arr.forEach((record) => { + if (record.files === undefined) return; + + let recordFiles = record.files; + if (recordFiles.length === undefined) recordFiles = [recordFiles]; + files.push(...recordFiles); + + // set score for the word in each file + recordFiles.forEach((file) => { + if (!scoreMap.has(file)) scoreMap.set(file, {}); + scoreMap.get(file)[word] = record.score; + }); + }); + + // create the mapping + files.forEach((file) => { + if (fileMap.has(file) && fileMap.get(file).indexOf(word) === -1) + fileMap.get(file).push(word); + else fileMap.set(file, [word]); + }); + }); + + // now check if the files don't contain excluded terms + const results = []; + for (const [file, wordList] of fileMap) { + // check if all requirements are matched + + // as search terms with length < 3 are discarded + const filteredTermCount = [...searchTerms].filter( + (term) => term.length > 2 + ).length; + if ( + wordList.length !== searchTerms.size && + wordList.length !== filteredTermCount + ) + continue; + + // ensure that none of the excluded terms is in the search result + if ( + [...excludedTerms].some( + (term) => + terms[term] === file || + titleTerms[term] === file || + (terms[term] || []).includes(file) || + (titleTerms[term] || []).includes(file) + ) + ) + break; + + // select one (max) score for the file. + const score = Math.max(...wordList.map((w) => scoreMap.get(file)[w])); + // add result to the result list + results.push([ + docNames[file], + titles[file], + "", + null, + score, + filenames[file], + ]); + } + return results; + }, + + /** + * helper function to return a node containing the + * search summary for a given text. keywords is a list + * of stemmed words. + */ + makeSearchSummary: (htmlText, keywords) => { + const text = Search.htmlToText(htmlText); + if (text === "") return null; + + const textLower = text.toLowerCase(); + const actualStartPosition = [...keywords] + .map((k) => textLower.indexOf(k.toLowerCase())) + .filter((i) => i > -1) + .slice(-1)[0]; + const startWithContext = Math.max(actualStartPosition - 120, 0); + + const top = startWithContext === 0 ? "" : "..."; + const tail = startWithContext + 240 < text.length ? "..." : ""; + + let summary = document.createElement("p"); + summary.classList.add("context"); + summary.textContent = top + text.substr(startWithContext, 240).trim() + tail; + + return summary; + }, +}; + +_ready(Search.init); diff --git a/docs/build/_static/sphinx_highlight.js b/docs/build/_static/sphinx_highlight.js new file mode 100644 index 0000000..8a96c69 --- /dev/null +++ b/docs/build/_static/sphinx_highlight.js @@ -0,0 +1,154 @@ +/* Highlighting utilities for Sphinx HTML documentation. */ +"use strict"; + +const SPHINX_HIGHLIGHT_ENABLED = true + +/** + * highlight a given string on a node by wrapping it in + * span elements with the given class name. + */ +const _highlight = (node, addItems, text, className) => { + if (node.nodeType === Node.TEXT_NODE) { + const val = node.nodeValue; + const parent = node.parentNode; + const pos = val.toLowerCase().indexOf(text); + if ( + pos >= 0 && + !parent.classList.contains(className) && + !parent.classList.contains("nohighlight") + ) { + let span; + + const closestNode = parent.closest("body, svg, foreignObject"); + const isInSVG = closestNode && closestNode.matches("svg"); + if (isInSVG) { + span = document.createElementNS("http://www.w3.org/2000/svg", "tspan"); + } else { + span = document.createElement("span"); + span.classList.add(className); + } + + span.appendChild(document.createTextNode(val.substr(pos, text.length))); + const rest = document.createTextNode(val.substr(pos + text.length)); + parent.insertBefore( + span, + parent.insertBefore( + rest, + node.nextSibling + ) + ); + node.nodeValue = val.substr(0, pos); + /* There may be more occurrences of search term in this node. So call this + * function recursively on the remaining fragment. + */ + _highlight(rest, addItems, text, className); + + if (isInSVG) { + const rect = document.createElementNS( + "http://www.w3.org/2000/svg", + "rect" + ); + const bbox = parent.getBBox(); + rect.x.baseVal.value = bbox.x; + rect.y.baseVal.value = bbox.y; + rect.width.baseVal.value = bbox.width; + rect.height.baseVal.value = bbox.height; + rect.setAttribute("class", className); + addItems.push({ parent: parent, target: rect }); + } + } + } else if (node.matches && !node.matches("button, select, textarea")) { + node.childNodes.forEach((el) => _highlight(el, addItems, text, className)); + } +}; +const _highlightText = (thisNode, text, className) => { + let addItems = []; + _highlight(thisNode, addItems, text, className); + addItems.forEach((obj) => + obj.parent.insertAdjacentElement("beforebegin", obj.target) + ); +}; + +/** + * Small JavaScript module for the documentation. + */ +const SphinxHighlight = { + + /** + * highlight the search words provided in localstorage in the text + */ + highlightSearchWords: () => { + if (!SPHINX_HIGHLIGHT_ENABLED) return; // bail if no highlight + + // get and clear terms from localstorage + const url = new URL(window.location); + const highlight = + localStorage.getItem("sphinx_highlight_terms") + || url.searchParams.get("highlight") + || ""; + localStorage.removeItem("sphinx_highlight_terms") + url.searchParams.delete("highlight"); + window.history.replaceState({}, "", url); + + // get individual terms from highlight string + const terms = highlight.toLowerCase().split(/\s+/).filter(x => x); + if (terms.length === 0) return; // nothing to do + + // There should never be more than one element matching "div.body" + const divBody = document.querySelectorAll("div.body"); + const body = divBody.length ? divBody[0] : document.querySelector("body"); + window.setTimeout(() => { + terms.forEach((term) => _highlightText(body, term, "highlighted")); + }, 10); + + const searchBox = document.getElementById("searchbox"); + if (searchBox === null) return; + searchBox.appendChild( + document + .createRange() + .createContextualFragment( + '

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

" + ) + ); + }, + + /** + * helper function to hide the search marks again + */ + hideSearchWords: () => { + document + .querySelectorAll("#searchbox .highlight-link") + .forEach((el) => el.remove()); + document + .querySelectorAll("span.highlighted") + .forEach((el) => el.classList.remove("highlighted")); + localStorage.removeItem("sphinx_highlight_terms") + }, + + initEscapeListener: () => { + // only install a listener if it is really needed + if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) return; + + document.addEventListener("keydown", (event) => { + // bail for input elements + if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return; + // bail with special keys + if (event.shiftKey || event.altKey || event.ctrlKey || event.metaKey) return; + if (DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS && (event.key === "Escape")) { + SphinxHighlight.hideSearchWords(); + event.preventDefault(); + } + }); + }, +}; + +_ready(() => { + /* Do not call highlightSearchWords() when we are on the search page. + * It will highlight words from the *previous* search query. + */ + if (typeof Search === "undefined") SphinxHighlight.highlightSearchWords(); + SphinxHighlight.initEscapeListener(); +}); diff --git a/docs/build/doctrees/environment.pickle b/docs/build/doctrees/environment.pickle new file mode 100644 index 0000000000000000000000000000000000000000..b5569b81867719a9af0c26252a6d5c4b69e6c5de GIT binary patch literal 18353 zcmds9dyF0DRkzpP$KCg?-%X<4q_4G`-Hp?vElykF+KKC~y$Nv&Mbu2@-aB_^X6Mda z&%?W$$fYGM^_EW*;Q=YC1V~i;fmDzRs)U3D0#W1y0so;QR76!(ph`suA<7>Ve&?L; zo5$VV)azDA;6KK9zVkiLci!jBerotvfBVt_{-@@XzUzgXOHO#xi=(jTglVp3Kb(0% z=b1{=o&5Bt^IQ3XI%N0z`KlW4MC~+ooQ@ag>ZqP0OTA#p>f5Osc&%KGS=Z9|dA#L! zF!11Vt`56V&&k!09p;#UT02`x^Jht@M(%DCHHJv)Weqg6g!bqf5 z#;u|)x7Dn(*$%RfL*UejWh3Km+6%1IbqKW$8_2U00C9^9NK!lX+Qo#UmNa0tX{VpH ztag%ET`$04vD`EdsWnY;lV9mH6=pqP(&|QW&rX>tMiXEHn8Ajx$*<-+aAzavmc?|& zXT7y0ZW>PQR)ChV7wLa)8gEA(XR#GT?RAX5;w7mUt`Q_tBRB0J<9k?e-vLA)0-5Hk zpUd3^_q6*F{7`fH8m!6{93V;qQn=?k-FLZHsplwem2NM0ukcX!jQehxV>pdE_LgZ^ z4Suz{y)<8y4r75Gu4VQb_B{lWl*S2c*bW>E)F%WX?@4Y8{G=S-GGiIbp-s1R{FOM0 z(pyWf7}%{>KwP)<#LYDax4W5Ib`V4xRyTY3qFYGv*dc85)47a;$(sxQ2$4atp*V`m6IJ^`mBp5Jr z8fWbkx7wjS=824$(IcD?mx=2GC1z=N@%@X5w+ch(DcQt{B4GX`;!9j9w& zL2AVjC`DhvNxRblDnceRP;(5);W~7_+j>^&(2F`5u7t2$0Or%EZAC5ORSSb+uLQky zC&)@%;9TY>3hqQb+cQ`G5JvYv_fZ-~sbj@X*TFv8j+OLn$Qh04NuENOzCizUe`}4U z9r$mHkHthe??P$>BsmH?0i|jL==+%~`$T;q08J|Hqwb;*_lyw}Rtu5~gt{v2Q|pe? zw>IoJ#HAFQnM<;MpNXV^T-S>o2MU=uz)-zj6oQ@{q5;5p!{eX>%jtVTv}Ue`n?QDz zrg=sbNovrG)eUT{t?y~N4;ncF;~ zr5z+3epwx-4~4dJkk@lR;C@gReyC?}dOg5F@1afXVFg}@hZC-$zuw*q*2OzkWS z$GL}SL-*_M*J;#z*=AKZh+(=vj1C-lR{BqHf33BlXt<;7$Q(I$KQ7IpM6r6{B`&nC z>8_P)VHZFP@ia3$H;jug^|~IZ>Cr4)52Fpp815j8CvDc}?suedj7Mc&Cr1nOitM{h zrb@0=p){?bmt&gr?m&%3#mi{fML#0u)ViMm?t9($$%=wAV{gzWARBiWK;_Tb|9oxD@$Rb8OR)u*@!(dMM$eaX^+E(^Ik@0 zJCFt4v+mGM{Av)POW`(asueRr~jnqo- zeVEvXHLcU&r6I2)2n*iKB)4?!n;y`i8{PN2KgLk^ocomgc#r#p^q=AWkjk-LKk+e{ z8n%X&^*gX-p|#nN;$_5`OhBP68_W(h#?3Ma3LN;3LOZ~eL=*;mgy$4}L3iu5S$y$O z*+}1kDGE|pC$YxuM|n)yZt=m?(4T%)uPLT(m0Eb5Msh#!QcXtNGNAy-%CxjwQCo?r zQUJ6MvyJ1tjk4XCR4}MgSWhywoR78w9tji2j@vF-qm>O21Ddh=%49>d*Z@GL;|-NY zvEJ-S*$>$`vJS@fNFAFE7es~*qKEZJp%7vgGW*Qc2%4iT?Pp|N8RKu5jX!-nVFH*F zFp^;Az`ieTNiJSgE9pdSaH^rDrXDN{=)D%wSEE3mlo3{y?2I^B)||2p^$-5OB6>t$ z3)$}-Eo!Q_CTAt>L$-yvi3b^X}QEtoQ?>qF>~>zu2n+%)Yc=a!e-op8xdI!@r-jF&^zGFm`rbo3bk8x6pgl)I+JMMEr6$1*rl4JnMk+RC7uQaDmP)40r}uHgk72XS{|(}GZrA%0-CyB025M~A4FiVg zt>co}O(%J(M?jv#_G_<~E{i}OAOR&1W0h4&WJf0s9zeRmQTJlp2dh)Pb}pY(()oS@|o&I|kWd8>($=3f2Ckz&{Iv`qM5*)ayUL3;O~;>}hsJstlE`x4T*0ansR z2q**GS41PH>xLR3@3g&gu;95V8d*}Zrqs7kYtLSX4j0y-s1bfeP`tX!kp%1#IHI48 zf#jbpl*$|!-wV4D1!{EMw7xZXFQ@(Qp}%_TbD=|cahesYw;6StCS<9mu6jw^37}7L zQAsH==FK9z2#8q&+sSVRvO9YhJ1^0q#!L`J)7~*NMTi4BsqF<|>CE8fq=B~M2$8KK z?ov<-Es+}Bwq3F<)##ZIE`IWncfX{C{1kTyoee?^z=yLCVGU6LM;Jx{q{0-TsoBw@ zo$=J#ZLgUq;)-n|{)#Y3nil@}OxyB07J{_wSYSDj3HP0+NGyzk-C(nAOAP9DXA6wd z5g&RKb}d2*bRhl}b+LCyssIh7Gy~EH4RWKrknA`$Mv)FgAmDjV>EJH~0%L^lCQ~;C zM_U}Jgk<9_y|oR>yocb$iFUs)Ch^YD5KlD69diz)f25BIka(hn`tgjsk4 zT9=&pj+JipP4rRse7o*>Pse*ich-g%$r1Q^a7COLP7zIBc*@7Xp^z3%(1*Pfc688_ zlMw}k10qL?SJM%8)2jdM(18PFZ5%DZ9p@%R!Z?gS?1YOD3`Mt-WjDQ?3Bss@XUlHW zWjApoiwP?0thXpg-9Z!?2?r6UizWwB^q(zfLVphN6|l-&vD2eSY#n~094nzrqg%F% zDNdDLdR_>lE$$Vux}sABbqQ=6;Ys)71-!CHiTxugQ~+nn6|}QHp;gC6aA_sV9w_^f zYeDft$PNk*L7bHLRJnkno5WSGmvbF2=i-CIqY{^5W;sjZ<(3yNyB=lf${`h874yoN zxnhg~l%tyELZDU3MvBN3vI%5bAYvADC3IRw^C-m4jZC6*r1a`tR6~#jWv4X+ zJA&M47hkvpl9o4ar142^zyKpYDc9GowFYpyfFt;N#H0qW;f8EUh@iwxP zwbYb&KAdL*3#}YfM`|r1q=JD@9I3(z%!PJv! z;#STe|JMkPqZTQ(TbO=U?_7+4WT~C698xC-8(n15khVz)FDC|p9_1<#e*(in+C_CgX0qGWMNjEJA%YJm)sd`z6mwyF3BtXPJ1LW}D(Wj^AvRxl28Fr0Cb4h=1%@u zDtj2yIn++>-vu-Je~AYJrVwl*6VDDd?5!mK0+P)ZWyC1ZMc9R1M2RBTA%Z(8fhYp( z1Zr`iW;Bn0fj?@sMUa(3%hrLZn7diqs=zXhLCczwKXogTD+0ra4>V@v>AoX7c-~%Q9Ep& zeQ)#Z`_4Ui_S}>2Z&E$R()dqDS+fm@-Ld;=Gj+X$r)-J|ojSo*GmV;CC>Vj~v<@bG zw272J(@UE$!m^;#w9_UPY^11GKnlPMF^AKn%z5)Aq&x_(FEz!f^KLpzx&IG15>)d) z(#a0L2<=F>`Ty#OpUtTxNR3FcJomqaqb4m|jaU30QVfSYc4gqM=!yjJ+OVi4{2D{H zsC*$yn?pQ+G~idAlgv7TWRPA?eA7Wu$Y^TAAwnI6|4ppuf0rJAPiSrs5es2*gL^{# z_%f9oE!*MpMdLOvqu6MKUGg3wrryI>_614EW}!UfVH5@V_7k7(E0meBYqL zJ+bN^K+9^@vi*NSEAGMnSNso({5SdU-{rsmkpKRZ|I7UU!vFp-&BbUP8kp7pZ-Udz zE2A1As)75r*J8U*bzUM4grC2B=8T;7%$erG@*B6iud6@*#r4-;z580&eB<`(U%LCn z@a}7GsMxvtJL%om;^os#Fs0pmo?R<&VJn6|+k_%$W(gvH%?&Sgo7XNpf4RAE%_GOR zc>!|74m(YlNZ`RJ;Lbg8De~_mV49ahDp%p?;AvrX&qlMUBSEE22-gZ>n55uXeUT#= z7$JUHKhk)4r237S_)zUm9vZ;j4|69E&|G{cC-4inXF~a{{|kt%;e>X-E1f#~r_*DY z%RNz{$;NI}Yv^>0M12Hbxqhbw2m4Sg-mHR3R>j4BS^JLt+`D| zT8$wzpcCmskdaVN?148fP^t~?!8ycx)`F-76KBNrIl1j3I@)~0X5E2 zD2c)V;YBqL-CWrKy_!}06(T0#`g4QWoRAZ|kGkw7M%0YP*Wv~w0Mf0w?Z1g+c@lH& zc1P7)gv=VG1@-WTNYKSJTI`04VB5uH(Fl9-8SJ`XQ;+B&ZzgnYe;4uRen@smDy2%P z6*?o?cMwOZNV|fJ7W|PqM9p88R7;aY6(=1KSkdMIbMbB+YE085wEf71dwXEk$^qvM z(@eB77^jl8-Ge2xz-&-r*FvbOSMR50&OxD{dkJ^OTJ@#k?8obP@^8_8G+vk&;imv| zaHBRcLw(j-XR@(4{aO>&wJwb3F|!BQ&|J+d7kzsG4?jpuFQ~)3AsFQF{?sU*i?l)K z%_yI;!?N6Gu-u;fwCfaV1k;1s#gkACe&gaf{|+Wos3q=Fa1bs6?L$rA>1?8ep^dU? zxR`jQIzPBRG*q&mFuV$EXaVr^n5)W&D@SF+Kez7<>j`(rXFcI7_dDSh2Fjjp(yt0f zl(Y-+;lB)Mg*Ocen$pI-N$?M7T1|ql)+h0+u+O~-Oi0bFRVTGSqWLS^{(+?C{|ZLj zC!zfzhW^M1?Q67;dnPphOVoX=K*C-Wc1&*btNY&RUKFM${L1}Kc)t`jB|=WBP4=d* zZ)0D3(N`5VNMBVL)7OZsRHv@*((M0R)b*Wxqxen4*!M8meyPi#U@zJ_F0}Pe``+hX zw52Ef*8NU+kF+&t{M7B5y2YYKL_g>1;F(IfB)NQwXaZYJcP>< z)N>$dPag=B!QE9gBDo(zLK(_Oh;%Tz?|+%7a;lT{ka#v}0N|1vJkT8F)+kjp!!1nw z6eBO2`lwdyL>7W(=!GxEP~A=NIH$wza-Ws^7$ zeUBwR7HCD+?-ga^ZxUypfTLN2-9eaC2V}m8kn)@S>g>CA%Q4jQ6aMcLW{y!ChxEZF z#Yb_lV$r_%j>nz=NA659)RPtdS81XKB%7%#A9G*bM&4=*0o_fj_{s+Uc0i$@!KnW3 zi39(SY1W6R=mh1h$hb-goYYsM-XP{Gg6PtE`Vy_)@5a`%fYLAZC%9po9jpGSyaz-l7?^b&D7BSt#&} z_EBn--wXar5RU$Jdb|xh={NDnRD*g*eFH@*sn0gUw=)h~QX`MyfFzCaNu6bCs*s9U zju)GP)5FwC*(PbBM4IVGMKx-!+9LhX3PR|$qM-P`i@P2jXe@d+YBM&>syt}EHa}-4 zC`Wm0a4ro&zy`9Rjo1|EC-?t?E_n2Ue!T+>a%N{5aaM3NzHFmtsH{_nfm-uK(aaY+ zVZOJc543R3@eWBU&C#X3h%1G~j@m0q<>|E2>$H`_Iv2&e7?IEtHYKUx5nMyX)hfau z5}({pAY06}ui$QxMA&~Ykd!VRVVrn(V3Ry4zC%KUzu0)T$Ho^1y~pB63lbrmqc|c} zvhNZ1F8WJGfLw0*O0XWmD7&#izkf{q&Au^3Swm3=P{YKZS?uYU!nl;k5E~+arwygQ zB0l4o^BefJKUY#uakrS_YdnR&7ux-&%KOj`_%}d&z!Ik`3s{PGic`Y+Jq8a*Uv%2|*JV`(#* zzJ0%FBAZ?IENI$~U92%(dKZ5tm>vj%l=SvG;JdQyU+)EA3f((ODLX$rykE|}M|xC8 z-nNTpvV%qsV*MYIM!$c*_cw_A`?xtGwB7Z7hm8r%})miu2MoiTEab!jQ`h(F+CB_2MM4A;)L@ZlnC4)gwD2Vc75 zeV8lX@B?KK@JEc2qAD3FRMG)6HRB~OIMqJe$o^KU4q&L-sM@+v)*(>2l6(cu_;?Nb zSs}{d0>I9{7KVtK1PMms{dggdV!xLi&p)M_`U5v zgD29wm-s)NTBq782hx=tmD7w45F02ZQ$zTii27W{Odyg`MDy@*eGPkuxsa;TX$s%; zTKIT?tqbl-LU=nVkV#*Am;HT@=Psa!sLZMYHdnxrcC@Pr^7PBkEX>|U@K-M!xJT5b zjBER!#O(03%wPP_MVe~Pda?X#3dkLAZV8<707o-jrH(l{!0m;%UdXxEd!d^ z$kt*J-h^!ZG?s!;^Q1ir8pG zqR~H(4{WK5JK?0uPiH9UF`~?VALgJaffZxpAyL-LCPIv@MYu!0> z=FH4FzwjL#^j>mS3HuNrGS|rjgPHo4gIK}_yd}Fm29GTns_mhiVCmKBYM>f z1SN`wUhkmo&eVA?=fR#-L?{o;@8;C|I!V0iU-GVhdF%D-Td%+2y?X7{*EZYVOLH&4 z3<*i5JjJ-QB0ZcVi>RW}fu~aM02lBgzQ>cnRj-#Tk1J2IG><}$C@-QoOFKvtMR)=k z)Dvl{ygMoll%VvE7ji)Z#rNrE!Den3tfkMrONT~D|6iB;pfEPq&5Xdns$lc7M|7Jg zB{-A@fEYkb^H9S0dM1d7lpx}}k&xJZ&4zh49`s1CCuraDw1#oCB{O1xG@A)3so1AQ zu4fb(m=y(Uvx{t6xBLny1xC#ZdvA7G8q+RGx?e3ZD!XrU)m1rT{(!59^tujcU96W~ zx30^RkPbJ6RE0hl@q`xJjl2f~&PZd?G#LS%HCWRacMX#b1$neKrCHOiF$Bfbk{w&4)JasC<;Pq4C<&q4jcb6;Xy>sK%O>gZT zZhXtT0aqtU=-m=2JSB}Ra|~a~1vN3iyO~HOY&enY&LKGgxt}Li^&Wx(6-1>%I=?ci zZ(>QB4C*&&k8e`xxaqD|jJ5do(`)f-(BfOr+=~9i|AJ=5cYLdUM|vt!-egxSLRuAK zEK+7oR7~?Etf|+bo=w3IUATLE?j%UEi@IU`3&8;P7Tkq^d7cDO9#Rw9t>@3iWEj#+ zv10oy!Uh7haXj6+fryKBatppWh|*qhq??R~A(G3HUMQuE2(w8Z_o$#@u|1{R)L8O|rkBc_ckaT8GAar(>3DvnMkfc3I#$2FeAmT> zj!HZIqytoUWT%Q@HrYX7>CO7ZlKHeiLh3%hfvu+}eEy3rH;+TswThruZzdrRC|nty zsYuV5z~-!#|2Q=U*N^MqdU6>0uy&+X3$D3d9wFoU5l67C%7^h0Te@Xte6DC*o7PKP zNDy0hpfwAnJMOe!sV>BRZBIX?=QE0%B?Es5{+fW20g;0zHo(`mc57GkY$d%GF#dS* zeb@9kyNRBbDg?IizhgF~ld$+bZ1cNGIMtbS6YBtlf~6>=%x8=eqhNp5GZ?9Z47qUH zh}LuXPls8=1FnE*Gkuqcq&T$ePzMbtQrP$+2GyUIs6LNld~(_`409C`4D+v^#QZUs zem=G^@Xmf&S){U9oWdMPu8&#l@77|!t@xQ6|6yVbt5gzdR{7^CR$+g7Duevvw9B1j zkbgbBLD*kwC$F2~0+jaIX`9#0V3_~*B<54iu;3g=QX&F2X@uR?GgDK??Jy>dOfe>{ zAn{s3V_WQg-iSD{Hd%W*bL>6~DW~1@1dHsxgmwRwQK}2nO>&W4+&%w<1Jtcz_?Mr8 z|8c{N^FbBrt01nME-)7Q%!aMvepYi^8%B?1lT|pC3E&+B@J<=P$LXV*t%vth(*y|t=3Fk(0XY^u_3)3$6rK}x2Ur}s4 z-qEv?DuvLE26M&aMcXj;QRX50Bfd7jL!umMstVk?ndU0XRk6dmJGzC~?W)8AgAi>Z zy23caV9srbgp=%H*e-{;h%j0}PWMgwVP>&$!_)@{g*2zGzm-`9-y4c zRloB_M{<0>aD39ILZrfHfK-I?#unK;Kt5S=nyyJ{SSf|RG%+(FV)y&TJr|wa@foVs zFC3qkSge=L9e_2-prXijgbNW#200oHXgow#Jc}YwKZCYA6`_yf5lF!{ro!COO|G$ z>Z5Z7*D~^RDyd&zX;Bg=f1gW^M#jkULoQ9-g^QG@oT*#`ZZ?n0NH~M53xS%F%^y|E z7tI$oL4R!OWZ1??3t{p()U~4_Ai84w3&=?Z0Aj>rR1V)a1n)#-jfL9`r;7q8U zGT+`y=-pUBGv521j~X z9^i#$=rcZG5q`F%H@%{smoXlS{P%MBwS=Ocv12#%qck98BXTKVXq5vP-uWA}Y*mQW zdwGVk%e-gV&Z3M1XhT5ZNgo)f0>i2a6*BKl@bTDyH%f`~M)TOPR{%5USwgt*0gk{Z zYPchPApqB&Pf-d+KHlC;ptZ+dDc>Xj)~N5o+L4~7$$o(XOwYP-0{;aRO_DHgQogGU zZJV`%LjhU}@fEN^|7F6rUOh&2PctAxT7NV!RjPT_0e!|0-S-;1#}0SD1xMfghRKP# zW#&xLYV!iScVs7za`v2gvp8f|Eg$LZs8bBYEEQ&t zducR6h9#b#Ada|O$0W9@UG1XPWAg3eqKWhuCS{c~=rR#Y0`$uO3@UUyaYRr#l#6^a zbEBkx1g(8gd>ej&XBc=G-oea!iQ8}#QjU@5Mr3Quxw6v*cn0P%tsR=ER|W`EfaSf- Fe*>j0QU3q{ literal 0 HcmV?d00001 diff --git a/docs/build/genindex.html b/docs/build/genindex.html new file mode 100644 index 0000000..35f1031 --- /dev/null +++ b/docs/build/genindex.html @@ -0,0 +1,103 @@ + + + + + + + Index — fn_gen "0.0.1" documentation + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ + +

Index

+ +
+ +
+ + +
+ +
+
+ +
+
+
+ ©2024, Ali Nwegy. + + | + Powered by Sphinx 7.2.6 + & Alabaster 0.7.16 + +
+ + + + + + \ No newline at end of file diff --git a/docs/build/html/.buildinfo b/docs/build/html/.buildinfo new file mode 100644 index 0000000..0b451fb --- /dev/null +++ b/docs/build/html/.buildinfo @@ -0,0 +1,4 @@ +# Sphinx build info version 1 +# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. +config: 47101a726535b145db2ce530805d96c6 +tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/docs/build/html/_sources/index.rst.txt b/docs/build/html/_sources/index.rst.txt new file mode 100644 index 0000000..6203afb --- /dev/null +++ b/docs/build/html/_sources/index.rst.txt @@ -0,0 +1,22 @@ +.. fn_gen documentation master file, created by + sphinx-quickstart on Tue Jan 16 17:51:58 2024. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to fn_gen's documentation! +================================== + +**fn_gen** (/ˈfʌŋkʃən ˈʤɛnəˌreɪtər/) is a Python library for usage with SCPI (Simple Command Protocol for measurement Instruments) compliant function generators. + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/docs/build/html/_static/alabaster.css b/docs/build/html/_static/alabaster.css new file mode 100644 index 0000000..e3174bf --- /dev/null +++ b/docs/build/html/_static/alabaster.css @@ -0,0 +1,708 @@ +@import url("basic.css"); + +/* -- page layout ----------------------------------------------------------- */ + +body { + font-family: Georgia, serif; + font-size: 17px; + background-color: #fff; + color: #000; + margin: 0; + padding: 0; +} + + +div.document { + width: 940px; + margin: 30px auto 0 auto; +} + +div.documentwrapper { + float: left; + width: 100%; +} + +div.bodywrapper { + margin: 0 0 0 220px; +} + +div.sphinxsidebar { + width: 220px; + font-size: 14px; + line-height: 1.5; +} + +hr { + border: 1px solid #B1B4B6; +} + +div.body { + background-color: #fff; + color: #3E4349; + padding: 0 30px 0 30px; +} + +div.body > .section { + text-align: left; +} + +div.footer { + width: 940px; + margin: 20px auto 30px auto; + font-size: 14px; + color: #888; + text-align: right; +} + +div.footer a { + color: #888; +} + +p.caption { + font-family: inherit; + font-size: inherit; +} + + +div.relations { + display: none; +} + + +div.sphinxsidebar { + max-height: 100%; + overflow-y: auto; +} + +div.sphinxsidebar a { + color: #444; + text-decoration: none; + border-bottom: 1px dotted #999; +} + +div.sphinxsidebar a:hover { + border-bottom: 1px solid #999; +} + +div.sphinxsidebarwrapper { + padding: 18px 10px; +} + +div.sphinxsidebarwrapper p.logo { + padding: 0; + margin: -10px 0 0 0px; + text-align: center; +} + +div.sphinxsidebarwrapper h1.logo { + margin-top: -10px; + text-align: center; + margin-bottom: 5px; + text-align: left; +} + +div.sphinxsidebarwrapper h1.logo-name { + margin-top: 0px; +} + +div.sphinxsidebarwrapper p.blurb { + margin-top: 0; + font-style: normal; +} + +div.sphinxsidebar h3, +div.sphinxsidebar h4 { + font-family: Georgia, serif; + color: #444; + font-size: 24px; + font-weight: normal; + margin: 0 0 5px 0; + padding: 0; +} + +div.sphinxsidebar h4 { + font-size: 20px; +} + +div.sphinxsidebar h3 a { + color: #444; +} + +div.sphinxsidebar p.logo a, +div.sphinxsidebar h3 a, +div.sphinxsidebar p.logo a:hover, +div.sphinxsidebar h3 a:hover { + border: none; +} + +div.sphinxsidebar p { + color: #555; + margin: 10px 0; +} + +div.sphinxsidebar ul { + margin: 10px 0; + padding: 0; + color: #000; +} + +div.sphinxsidebar ul li.toctree-l1 > a { + font-size: 120%; +} + +div.sphinxsidebar ul li.toctree-l2 > a { + font-size: 110%; +} + +div.sphinxsidebar input { + border: 1px solid #CCC; + font-family: Georgia, serif; + font-size: 1em; +} + +div.sphinxsidebar #searchbox input[type="text"] { + width: 160px; +} + +div.sphinxsidebar .search > div { + display: table-cell; +} + +div.sphinxsidebar hr { + border: none; + height: 1px; + color: #AAA; + background: #AAA; + + text-align: left; + margin-left: 0; + width: 50%; +} + +div.sphinxsidebar .badge { + border-bottom: none; +} + +div.sphinxsidebar .badge:hover { + border-bottom: none; +} + +/* To address an issue with donation coming after search */ +div.sphinxsidebar h3.donation { + margin-top: 10px; +} + +/* -- body styles ----------------------------------------------------------- */ + +a { + color: #004B6B; + text-decoration: underline; +} + +a:hover { + color: #6D4100; + text-decoration: underline; +} + +div.body h1, +div.body h2, +div.body h3, +div.body h4, +div.body h5, +div.body h6 { + font-family: Georgia, serif; + font-weight: normal; + margin: 30px 0px 10px 0px; + padding: 0; +} + +div.body h1 { margin-top: 0; padding-top: 0; font-size: 240%; } +div.body h2 { font-size: 180%; } +div.body h3 { font-size: 150%; } +div.body h4 { font-size: 130%; } +div.body h5 { font-size: 100%; } +div.body h6 { font-size: 100%; } + +a.headerlink { + color: #DDD; + padding: 0 4px; + text-decoration: none; +} + +a.headerlink:hover { + color: #444; + background: #EAEAEA; +} + +div.body p, div.body dd, div.body li { + line-height: 1.4em; +} + +div.admonition { + margin: 20px 0px; + padding: 10px 30px; + background-color: #EEE; + border: 1px solid #CCC; +} + +div.admonition tt.xref, div.admonition code.xref, div.admonition a tt { + background-color: #FBFBFB; + border-bottom: 1px solid #fafafa; +} + +div.admonition p.admonition-title { + font-family: Georgia, serif; + font-weight: normal; + font-size: 24px; + margin: 0 0 10px 0; + padding: 0; + line-height: 1; +} + +div.admonition p.last { + margin-bottom: 0; +} + +div.highlight { + background-color: #fff; +} + +dt:target, .highlight { + background: #FAF3E8; +} + +div.warning { + background-color: #FCC; + border: 1px solid #FAA; +} + +div.danger { + background-color: #FCC; + border: 1px solid #FAA; + -moz-box-shadow: 2px 2px 4px #D52C2C; + -webkit-box-shadow: 2px 2px 4px #D52C2C; + box-shadow: 2px 2px 4px #D52C2C; +} + +div.error { + background-color: #FCC; + border: 1px solid #FAA; + -moz-box-shadow: 2px 2px 4px #D52C2C; + -webkit-box-shadow: 2px 2px 4px #D52C2C; + box-shadow: 2px 2px 4px #D52C2C; +} + +div.caution { + background-color: #FCC; + border: 1px solid #FAA; +} + +div.attention { + background-color: #FCC; + border: 1px solid #FAA; +} + +div.important { + background-color: #EEE; + border: 1px solid #CCC; +} + +div.note { + background-color: #EEE; + border: 1px solid #CCC; +} + +div.tip { + background-color: #EEE; + border: 1px solid #CCC; +} + +div.hint { + background-color: #EEE; + border: 1px solid #CCC; +} + +div.seealso { + background-color: #EEE; + border: 1px solid #CCC; +} + +div.topic { + background-color: #EEE; +} + +p.admonition-title { + display: inline; +} + +p.admonition-title:after { + content: ":"; +} + +pre, tt, code { + font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace; + font-size: 0.9em; +} + +.hll { + background-color: #FFC; + margin: 0 -12px; + padding: 0 12px; + display: block; +} + +img.screenshot { +} + +tt.descname, tt.descclassname, code.descname, code.descclassname { + font-size: 0.95em; +} + +tt.descname, code.descname { + padding-right: 0.08em; +} + +img.screenshot { + -moz-box-shadow: 2px 2px 4px #EEE; + -webkit-box-shadow: 2px 2px 4px #EEE; + box-shadow: 2px 2px 4px #EEE; +} + +table.docutils { + border: 1px solid #888; + -moz-box-shadow: 2px 2px 4px #EEE; + -webkit-box-shadow: 2px 2px 4px #EEE; + box-shadow: 2px 2px 4px #EEE; +} + +table.docutils td, table.docutils th { + border: 1px solid #888; + padding: 0.25em 0.7em; +} + +table.field-list, table.footnote { + border: none; + -moz-box-shadow: none; + -webkit-box-shadow: none; + box-shadow: none; +} + +table.footnote { + margin: 15px 0; + width: 100%; + border: 1px solid #EEE; + background: #FDFDFD; + font-size: 0.9em; +} + +table.footnote + table.footnote { + margin-top: -15px; + border-top: none; +} + +table.field-list th { + padding: 0 0.8em 0 0; +} + +table.field-list td { + padding: 0; +} + +table.field-list p { + margin-bottom: 0.8em; +} + +/* Cloned from + * https://github.com/sphinx-doc/sphinx/commit/ef60dbfce09286b20b7385333d63a60321784e68 + */ +.field-name { + -moz-hyphens: manual; + -ms-hyphens: manual; + -webkit-hyphens: manual; + hyphens: manual; +} + +table.footnote td.label { + width: .1px; + padding: 0.3em 0 0.3em 0.5em; +} + +table.footnote td { + padding: 0.3em 0.5em; +} + +dl { + margin-left: 0; + margin-right: 0; + margin-top: 0; + padding: 0; +} + +dl dd { + margin-left: 30px; +} + +blockquote { + margin: 0 0 0 30px; + padding: 0; +} + +ul, ol { + /* Matches the 30px from the narrow-screen "li > ul" selector below */ + margin: 10px 0 10px 30px; + padding: 0; +} + +pre { + background: #EEE; + padding: 7px 30px; + margin: 15px 0px; + line-height: 1.3em; +} + +div.viewcode-block:target { + background: #ffd; +} + +dl pre, blockquote pre, li pre { + margin-left: 0; + padding-left: 30px; +} + +tt, code { + background-color: #ecf0f3; + color: #222; + /* padding: 1px 2px; */ +} + +tt.xref, code.xref, a tt { + background-color: #FBFBFB; + border-bottom: 1px solid #fff; +} + +a.reference { + text-decoration: none; + border-bottom: 1px dotted #004B6B; +} + +/* Don't put an underline on images */ +a.image-reference, a.image-reference:hover { + border-bottom: none; +} + +a.reference:hover { + border-bottom: 1px solid #6D4100; +} + +a.footnote-reference { + text-decoration: none; + font-size: 0.7em; + vertical-align: top; + border-bottom: 1px dotted #004B6B; +} + +a.footnote-reference:hover { + border-bottom: 1px solid #6D4100; +} + +a:hover tt, a:hover code { + background: #EEE; +} + + +@media screen and (max-width: 870px) { + + div.sphinxsidebar { + display: none; + } + + div.document { + width: 100%; + + } + + div.documentwrapper { + margin-left: 0; + margin-top: 0; + margin-right: 0; + margin-bottom: 0; + } + + div.bodywrapper { + margin-top: 0; + margin-right: 0; + margin-bottom: 0; + margin-left: 0; + } + + ul { + margin-left: 0; + } + + li > ul { + /* Matches the 30px from the "ul, ol" selector above */ + margin-left: 30px; + } + + .document { + width: auto; + } + + .footer { + width: auto; + } + + .bodywrapper { + margin: 0; + } + + .footer { + width: auto; + } + + .github { + display: none; + } + + + +} + + + +@media screen and (max-width: 875px) { + + body { + margin: 0; + padding: 20px 30px; + } + + div.documentwrapper { + float: none; + background: #fff; + } + + div.sphinxsidebar { + display: block; + float: none; + width: 102.5%; + margin: 50px -30px -20px -30px; + padding: 10px 20px; + background: #333; + color: #FFF; + } + + div.sphinxsidebar h3, div.sphinxsidebar h4, div.sphinxsidebar p, + div.sphinxsidebar h3 a { + color: #fff; + } + + div.sphinxsidebar a { + color: #AAA; + } + + div.sphinxsidebar p.logo { + display: none; + } + + div.document { + width: 100%; + margin: 0; + } + + div.footer { + display: none; + } + + div.bodywrapper { + margin: 0; + } + + div.body { + min-height: 0; + padding: 0; + } + + .rtd_doc_footer { + display: none; + } + + .document { + width: auto; + } + + .footer { + width: auto; + } + + .footer { + width: auto; + } + + .github { + display: none; + } +} + + +/* misc. */ + +.revsys-inline { + display: none!important; +} + +/* Hide ugly table cell borders in ..bibliography:: directive output */ +table.docutils.citation, table.docutils.citation td, table.docutils.citation th { + border: none; + /* Below needed in some edge cases; if not applied, bottom shadows appear */ + -moz-box-shadow: none; + -webkit-box-shadow: none; + box-shadow: none; +} + + +/* relbar */ + +.related { + line-height: 30px; + width: 100%; + font-size: 0.9rem; +} + +.related.top { + border-bottom: 1px solid #EEE; + margin-bottom: 20px; +} + +.related.bottom { + border-top: 1px solid #EEE; +} + +.related ul { + padding: 0; + margin: 0; + list-style: none; +} + +.related li { + display: inline; +} + +nav#rellinks { + float: right; +} + +nav#rellinks li+li:before { + content: "|"; +} + +nav#breadcrumbs li+li:before { + content: "\00BB"; +} + +/* Hide certain items when printing */ +@media print { + div.related { + display: none; + } +} \ No newline at end of file diff --git a/docs/build/html/_static/basic.css b/docs/build/html/_static/basic.css new file mode 100644 index 0000000..4157edf --- /dev/null +++ b/docs/build/html/_static/basic.css @@ -0,0 +1,925 @@ +/* + * basic.css + * ~~~~~~~~~ + * + * Sphinx stylesheet -- basic theme. + * + * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +/* -- main layout ----------------------------------------------------------- */ + +div.clearer { + clear: both; +} + +div.section::after { + display: block; + content: ''; + clear: left; +} + +/* -- relbar ---------------------------------------------------------------- */ + +div.related { + width: 100%; + font-size: 90%; +} + +div.related h3 { + display: none; +} + +div.related ul { + margin: 0; + padding: 0 0 0 10px; + list-style: none; +} + +div.related li { + display: inline; +} + +div.related li.right { + float: right; + margin-right: 5px; +} + +/* -- sidebar --------------------------------------------------------------- */ + +div.sphinxsidebarwrapper { + padding: 10px 5px 0 10px; +} + +div.sphinxsidebar { + float: left; + width: 230px; + margin-left: -100%; + font-size: 90%; + word-wrap: break-word; + overflow-wrap : break-word; +} + +div.sphinxsidebar ul { + list-style: none; +} + +div.sphinxsidebar ul ul, +div.sphinxsidebar ul.want-points { + margin-left: 20px; + list-style: square; +} + +div.sphinxsidebar ul ul { + margin-top: 0; + margin-bottom: 0; +} + +div.sphinxsidebar form { + margin-top: 10px; +} + +div.sphinxsidebar input { + border: 1px solid #98dbcc; + font-family: sans-serif; + font-size: 1em; +} + +div.sphinxsidebar #searchbox form.search { + overflow: hidden; +} + +div.sphinxsidebar #searchbox input[type="text"] { + float: left; + width: 80%; + padding: 0.25em; + box-sizing: border-box; +} + +div.sphinxsidebar #searchbox input[type="submit"] { + float: left; + width: 20%; + border-left: none; + padding: 0.25em; + box-sizing: border-box; +} + + +img { + border: 0; + max-width: 100%; +} + +/* -- search page ----------------------------------------------------------- */ + +ul.search { + margin: 10px 0 0 20px; + padding: 0; +} + +ul.search li { + padding: 5px 0 5px 20px; + background-image: url(file.png); + background-repeat: no-repeat; + background-position: 0 7px; +} + +ul.search li a { + font-weight: bold; +} + +ul.search li p.context { + color: #888; + margin: 2px 0 0 30px; + text-align: left; +} + +ul.keywordmatches li.goodmatch a { + font-weight: bold; +} + +/* -- index page ------------------------------------------------------------ */ + +table.contentstable { + width: 90%; + margin-left: auto; + margin-right: auto; +} + +table.contentstable p.biglink { + line-height: 150%; +} + +a.biglink { + font-size: 1.3em; +} + +span.linkdescr { + font-style: italic; + padding-top: 5px; + font-size: 90%; +} + +/* -- general index --------------------------------------------------------- */ + +table.indextable { + width: 100%; +} + +table.indextable td { + text-align: left; + vertical-align: top; +} + +table.indextable ul { + margin-top: 0; + margin-bottom: 0; + list-style-type: none; +} + +table.indextable > tbody > tr > td > ul { + padding-left: 0em; +} + +table.indextable tr.pcap { + height: 10px; +} + +table.indextable tr.cap { + margin-top: 10px; + background-color: #f2f2f2; +} + +img.toggler { + margin-right: 3px; + margin-top: 3px; + cursor: pointer; +} + +div.modindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +div.genindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +/* -- domain module index --------------------------------------------------- */ + +table.modindextable td { + padding: 2px; + border-collapse: collapse; +} + +/* -- general body styles --------------------------------------------------- */ + +div.body { + min-width: inherit; + max-width: 800px; +} + +div.body p, div.body dd, div.body li, div.body blockquote { + -moz-hyphens: auto; + -ms-hyphens: auto; + -webkit-hyphens: auto; + hyphens: auto; +} + +a.headerlink { + visibility: hidden; +} + +a:visited { + color: #551A8B; +} + +h1:hover > a.headerlink, +h2:hover > a.headerlink, +h3:hover > a.headerlink, +h4:hover > a.headerlink, +h5:hover > a.headerlink, +h6:hover > a.headerlink, +dt:hover > a.headerlink, +caption:hover > a.headerlink, +p.caption:hover > a.headerlink, +div.code-block-caption:hover > a.headerlink { + visibility: visible; +} + +div.body p.caption { + text-align: inherit; +} + +div.body td { + text-align: left; +} + +.first { + margin-top: 0 !important; +} + +p.rubric { + margin-top: 30px; + font-weight: bold; +} + +img.align-left, figure.align-left, .figure.align-left, object.align-left { + clear: left; + float: left; + margin-right: 1em; +} + +img.align-right, figure.align-right, .figure.align-right, object.align-right { + clear: right; + float: right; + margin-left: 1em; +} + +img.align-center, figure.align-center, .figure.align-center, object.align-center { + display: block; + margin-left: auto; + margin-right: auto; +} + +img.align-default, figure.align-default, .figure.align-default { + display: block; + margin-left: auto; + margin-right: auto; +} + +.align-left { + text-align: left; +} + +.align-center { + text-align: center; +} + +.align-default { + text-align: center; +} + +.align-right { + text-align: right; +} + +/* -- sidebars -------------------------------------------------------------- */ + +div.sidebar, +aside.sidebar { + margin: 0 0 0.5em 1em; + border: 1px solid #ddb; + padding: 7px; + background-color: #ffe; + width: 40%; + float: right; + clear: right; + overflow-x: auto; +} + +p.sidebar-title { + font-weight: bold; +} + +nav.contents, +aside.topic, +div.admonition, div.topic, blockquote { + clear: left; +} + +/* -- topics ---------------------------------------------------------------- */ + +nav.contents, +aside.topic, +div.topic { + border: 1px solid #ccc; + padding: 7px; + margin: 10px 0 10px 0; +} + +p.topic-title { + font-size: 1.1em; + font-weight: bold; + margin-top: 10px; +} + +/* -- admonitions ----------------------------------------------------------- */ + +div.admonition { + margin-top: 10px; + margin-bottom: 10px; + padding: 7px; +} + +div.admonition dt { + font-weight: bold; +} + +p.admonition-title { + margin: 0px 10px 5px 0px; + font-weight: bold; +} + +div.body p.centered { + text-align: center; + margin-top: 25px; +} + +/* -- content of sidebars/topics/admonitions -------------------------------- */ + +div.sidebar > :last-child, +aside.sidebar > :last-child, +nav.contents > :last-child, +aside.topic > :last-child, +div.topic > :last-child, +div.admonition > :last-child { + margin-bottom: 0; +} + +div.sidebar::after, +aside.sidebar::after, +nav.contents::after, +aside.topic::after, +div.topic::after, +div.admonition::after, +blockquote::after { + display: block; + content: ''; + clear: both; +} + +/* -- tables ---------------------------------------------------------------- */ + +table.docutils { + margin-top: 10px; + margin-bottom: 10px; + border: 0; + border-collapse: collapse; +} + +table.align-center { + margin-left: auto; + margin-right: auto; +} + +table.align-default { + margin-left: auto; + margin-right: auto; +} + +table caption span.caption-number { + font-style: italic; +} + +table caption span.caption-text { +} + +table.docutils td, table.docutils th { + padding: 1px 8px 1px 5px; + border-top: 0; + border-left: 0; + border-right: 0; + border-bottom: 1px solid #aaa; +} + +th { + text-align: left; + padding-right: 5px; +} + +table.citation { + border-left: solid 1px gray; + margin-left: 1px; +} + +table.citation td { + border-bottom: none; +} + +th > :first-child, +td > :first-child { + margin-top: 0px; +} + +th > :last-child, +td > :last-child { + margin-bottom: 0px; +} + +/* -- figures --------------------------------------------------------------- */ + +div.figure, figure { + margin: 0.5em; + padding: 0.5em; +} + +div.figure p.caption, figcaption { + padding: 0.3em; +} + +div.figure p.caption span.caption-number, +figcaption span.caption-number { + font-style: italic; +} + +div.figure p.caption span.caption-text, +figcaption span.caption-text { +} + +/* -- field list styles ----------------------------------------------------- */ + +table.field-list td, table.field-list th { + border: 0 !important; +} + +.field-list ul { + margin: 0; + padding-left: 1em; +} + +.field-list p { + margin: 0; +} + +.field-name { + -moz-hyphens: manual; + -ms-hyphens: manual; + -webkit-hyphens: manual; + hyphens: manual; +} + +/* -- hlist styles ---------------------------------------------------------- */ + +table.hlist { + margin: 1em 0; +} + +table.hlist td { + vertical-align: top; +} + +/* -- object description styles --------------------------------------------- */ + +.sig { + font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace; +} + +.sig-name, code.descname { + background-color: transparent; + font-weight: bold; +} + +.sig-name { + font-size: 1.1em; +} + +code.descname { + font-size: 1.2em; +} + +.sig-prename, code.descclassname { + background-color: transparent; +} + +.optional { + font-size: 1.3em; +} + +.sig-paren { + font-size: larger; +} + +.sig-param.n { + font-style: italic; +} + +/* C++ specific styling */ + +.sig-inline.c-texpr, +.sig-inline.cpp-texpr { + font-family: unset; +} + +.sig.c .k, .sig.c .kt, +.sig.cpp .k, .sig.cpp .kt { + color: #0033B3; +} + +.sig.c .m, +.sig.cpp .m { + color: #1750EB; +} + +.sig.c .s, .sig.c .sc, +.sig.cpp .s, .sig.cpp .sc { + color: #067D17; +} + + +/* -- other body styles ----------------------------------------------------- */ + +ol.arabic { + list-style: decimal; +} + +ol.loweralpha { + list-style: lower-alpha; +} + +ol.upperalpha { + list-style: upper-alpha; +} + +ol.lowerroman { + list-style: lower-roman; +} + +ol.upperroman { + list-style: upper-roman; +} + +:not(li) > ol > li:first-child > :first-child, +:not(li) > ul > li:first-child > :first-child { + margin-top: 0px; +} + +:not(li) > ol > li:last-child > :last-child, +:not(li) > ul > li:last-child > :last-child { + margin-bottom: 0px; +} + +ol.simple ol p, +ol.simple ul p, +ul.simple ol p, +ul.simple ul p { + margin-top: 0; +} + +ol.simple > li:not(:first-child) > p, +ul.simple > li:not(:first-child) > p { + margin-top: 0; +} + +ol.simple p, +ul.simple p { + margin-bottom: 0; +} + +aside.footnote > span, +div.citation > span { + float: left; +} +aside.footnote > span:last-of-type, +div.citation > span:last-of-type { + padding-right: 0.5em; +} +aside.footnote > p { + margin-left: 2em; +} +div.citation > p { + margin-left: 4em; +} +aside.footnote > p:last-of-type, +div.citation > p:last-of-type { + margin-bottom: 0em; +} +aside.footnote > p:last-of-type:after, +div.citation > p:last-of-type:after { + content: ""; + clear: both; +} + +dl.field-list { + display: grid; + grid-template-columns: fit-content(30%) auto; +} + +dl.field-list > dt { + font-weight: bold; + word-break: break-word; + padding-left: 0.5em; + padding-right: 5px; +} + +dl.field-list > dd { + padding-left: 0.5em; + margin-top: 0em; + margin-left: 0em; + margin-bottom: 0em; +} + +dl { + margin-bottom: 15px; +} + +dd > :first-child { + margin-top: 0px; +} + +dd ul, dd table { + margin-bottom: 10px; +} + +dd { + margin-top: 3px; + margin-bottom: 10px; + margin-left: 30px; +} + +.sig dd { + margin-top: 0px; + margin-bottom: 0px; +} + +.sig dl { + margin-top: 0px; + margin-bottom: 0px; +} + +dl > dd:last-child, +dl > dd:last-child > :last-child { + margin-bottom: 0; +} + +dt:target, span.highlighted { + background-color: #fbe54e; +} + +rect.highlighted { + fill: #fbe54e; +} + +dl.glossary dt { + font-weight: bold; + font-size: 1.1em; +} + +.versionmodified { + font-style: italic; +} + +.system-message { + background-color: #fda; + padding: 5px; + border: 3px solid red; +} + +.footnote:target { + background-color: #ffa; +} + +.line-block { + display: block; + margin-top: 1em; + margin-bottom: 1em; +} + +.line-block .line-block { + margin-top: 0; + margin-bottom: 0; + margin-left: 1.5em; +} + +.guilabel, .menuselection { + font-family: sans-serif; +} + +.accelerator { + text-decoration: underline; +} + +.classifier { + font-style: oblique; +} + +.classifier:before { + font-style: normal; + margin: 0 0.5em; + content: ":"; + display: inline-block; +} + +abbr, acronym { + border-bottom: dotted 1px; + cursor: help; +} + +.translated { + background-color: rgba(207, 255, 207, 0.2) +} + +.untranslated { + background-color: rgba(255, 207, 207, 0.2) +} + +/* -- code displays --------------------------------------------------------- */ + +pre { + overflow: auto; + overflow-y: hidden; /* fixes display issues on Chrome browsers */ +} + +pre, div[class*="highlight-"] { + clear: both; +} + +span.pre { + -moz-hyphens: none; + -ms-hyphens: none; + -webkit-hyphens: none; + hyphens: none; + white-space: nowrap; +} + +div[class*="highlight-"] { + margin: 1em 0; +} + +td.linenos pre { + border: 0; + background-color: transparent; + color: #aaa; +} + +table.highlighttable { + display: block; +} + +table.highlighttable tbody { + display: block; +} + +table.highlighttable tr { + display: flex; +} + +table.highlighttable td { + margin: 0; + padding: 0; +} + +table.highlighttable td.linenos { + padding-right: 0.5em; +} + +table.highlighttable td.code { + flex: 1; + overflow: hidden; +} + +.highlight .hll { + display: block; +} + +div.highlight pre, +table.highlighttable pre { + margin: 0; +} + +div.code-block-caption + div { + margin-top: 0; +} + +div.code-block-caption { + margin-top: 1em; + padding: 2px 5px; + font-size: small; +} + +div.code-block-caption code { + background-color: transparent; +} + +table.highlighttable td.linenos, +span.linenos, +div.highlight span.gp { /* gp: Generic.Prompt */ + user-select: none; + -webkit-user-select: text; /* Safari fallback only */ + -webkit-user-select: none; /* Chrome/Safari */ + -moz-user-select: none; /* Firefox */ + -ms-user-select: none; /* IE10+ */ +} + +div.code-block-caption span.caption-number { + padding: 0.1em 0.3em; + font-style: italic; +} + +div.code-block-caption span.caption-text { +} + +div.literal-block-wrapper { + margin: 1em 0; +} + +code.xref, a code { + background-color: transparent; + font-weight: bold; +} + +h1 code, h2 code, h3 code, h4 code, h5 code, h6 code { + background-color: transparent; +} + +.viewcode-link { + float: right; +} + +.viewcode-back { + float: right; + font-family: sans-serif; +} + +div.viewcode-block:target { + margin: -1px -10px; + padding: 0 10px; +} + +/* -- math display ---------------------------------------------------------- */ + +img.math { + vertical-align: middle; +} + +div.body div.math p { + text-align: center; +} + +span.eqno { + float: right; +} + +span.eqno a.headerlink { + position: absolute; + z-index: 1; +} + +div.math:hover a.headerlink { + visibility: visible; +} + +/* -- printout stylesheet --------------------------------------------------- */ + +@media print { + div.document, + div.documentwrapper, + div.bodywrapper { + margin: 0 !important; + width: 100%; + } + + div.sphinxsidebar, + div.related, + div.footer, + #top-link { + display: none; + } +} \ No newline at end of file diff --git a/docs/build/html/_static/custom.css b/docs/build/html/_static/custom.css new file mode 100644 index 0000000..2a924f1 --- /dev/null +++ b/docs/build/html/_static/custom.css @@ -0,0 +1 @@ +/* This file intentionally left blank. */ diff --git a/docs/build/html/_static/doctools.js b/docs/build/html/_static/doctools.js new file mode 100644 index 0000000..d06a71d --- /dev/null +++ b/docs/build/html/_static/doctools.js @@ -0,0 +1,156 @@ +/* + * doctools.js + * ~~~~~~~~~~~ + * + * Base JavaScript utilities for all Sphinx HTML documentation. + * + * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ +"use strict"; + +const BLACKLISTED_KEY_CONTROL_ELEMENTS = new Set([ + "TEXTAREA", + "INPUT", + "SELECT", + "BUTTON", +]); + +const _ready = (callback) => { + if (document.readyState !== "loading") { + callback(); + } else { + document.addEventListener("DOMContentLoaded", callback); + } +}; + +/** + * Small JavaScript module for the documentation. + */ +const Documentation = { + init: () => { + Documentation.initDomainIndexTable(); + Documentation.initOnKeyListeners(); + }, + + /** + * i18n support + */ + TRANSLATIONS: {}, + PLURAL_EXPR: (n) => (n === 1 ? 0 : 1), + LOCALE: "unknown", + + // gettext and ngettext don't access this so that the functions + // can safely bound to a different name (_ = Documentation.gettext) + gettext: (string) => { + const translated = Documentation.TRANSLATIONS[string]; + switch (typeof translated) { + case "undefined": + return string; // no translation + case "string": + return translated; // translation exists + default: + return translated[0]; // (singular, plural) translation tuple exists + } + }, + + ngettext: (singular, plural, n) => { + const translated = Documentation.TRANSLATIONS[singular]; + if (typeof translated !== "undefined") + return translated[Documentation.PLURAL_EXPR(n)]; + return n === 1 ? singular : plural; + }, + + addTranslations: (catalog) => { + Object.assign(Documentation.TRANSLATIONS, catalog.messages); + Documentation.PLURAL_EXPR = new Function( + "n", + `return (${catalog.plural_expr})` + ); + Documentation.LOCALE = catalog.locale; + }, + + /** + * helper function to focus on search bar + */ + focusSearchBar: () => { + document.querySelectorAll("input[name=q]")[0]?.focus(); + }, + + /** + * Initialise the domain index toggle buttons + */ + initDomainIndexTable: () => { + const toggler = (el) => { + const idNumber = el.id.substr(7); + const toggledRows = document.querySelectorAll(`tr.cg-${idNumber}`); + if (el.src.substr(-9) === "minus.png") { + el.src = `${el.src.substr(0, el.src.length - 9)}plus.png`; + toggledRows.forEach((el) => (el.style.display = "none")); + } else { + el.src = `${el.src.substr(0, el.src.length - 8)}minus.png`; + toggledRows.forEach((el) => (el.style.display = "")); + } + }; + + const togglerElements = document.querySelectorAll("img.toggler"); + togglerElements.forEach((el) => + el.addEventListener("click", (event) => toggler(event.currentTarget)) + ); + togglerElements.forEach((el) => (el.style.display = "")); + if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) togglerElements.forEach(toggler); + }, + + initOnKeyListeners: () => { + // only install a listener if it is really needed + if ( + !DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS && + !DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS + ) + return; + + document.addEventListener("keydown", (event) => { + // bail for input elements + if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return; + // bail with special keys + if (event.altKey || event.ctrlKey || event.metaKey) return; + + if (!event.shiftKey) { + switch (event.key) { + case "ArrowLeft": + if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break; + + const prevLink = document.querySelector('link[rel="prev"]'); + if (prevLink && prevLink.href) { + window.location.href = prevLink.href; + event.preventDefault(); + } + break; + case "ArrowRight": + if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break; + + const nextLink = document.querySelector('link[rel="next"]'); + if (nextLink && nextLink.href) { + window.location.href = nextLink.href; + event.preventDefault(); + } + break; + } + } + + // some keyboard layouts may need Shift to get / + switch (event.key) { + case "/": + if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) break; + Documentation.focusSearchBar(); + event.preventDefault(); + } + }); + }, +}; + +// quick alias for translations +const _ = Documentation.gettext; + +_ready(Documentation.init); diff --git a/docs/build/html/_static/documentation_options.js b/docs/build/html/_static/documentation_options.js new file mode 100644 index 0000000..010ec37 --- /dev/null +++ b/docs/build/html/_static/documentation_options.js @@ -0,0 +1,13 @@ +const DOCUMENTATION_OPTIONS = { + VERSION: '"0.0.1"', + LANGUAGE: 'en', + COLLAPSE_INDEX: false, + BUILDER: 'html', + FILE_SUFFIX: '.html', + LINK_SUFFIX: '.html', + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '.txt', + NAVIGATION_WITH_KEYS: false, + SHOW_SEARCH_SUMMARY: true, + ENABLE_SEARCH_SHORTCUTS: true, +}; \ No newline at end of file diff --git a/docs/build/html/_static/file.png b/docs/build/html/_static/file.png new file mode 100644 index 0000000000000000000000000000000000000000..a858a410e4faa62ce324d814e4b816fff83a6fb3 GIT binary patch literal 286 zcmV+(0pb3MP)s`hMrGg#P~ix$^RISR_I47Y|r1 z_CyJOe}D1){SET-^Amu_i71Lt6eYfZjRyw@I6OQAIXXHDfiX^GbOlHe=Ae4>0m)d(f|Me07*qoM6N<$f}vM^LjV8( literal 0 HcmV?d00001 diff --git a/docs/build/html/_static/language_data.js b/docs/build/html/_static/language_data.js new file mode 100644 index 0000000..250f566 --- /dev/null +++ b/docs/build/html/_static/language_data.js @@ -0,0 +1,199 @@ +/* + * language_data.js + * ~~~~~~~~~~~~~~~~ + * + * This script contains the language-specific data used by searchtools.js, + * namely the list of stopwords, stemmer, scorer and splitter. + * + * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +var stopwords = ["a", "and", "are", "as", "at", "be", "but", "by", "for", "if", "in", "into", "is", "it", "near", "no", "not", "of", "on", "or", "such", "that", "the", "their", "then", "there", "these", "they", "this", "to", "was", "will", "with"]; + + +/* Non-minified version is copied as a separate JS file, is available */ + +/** + * Porter Stemmer + */ +var Stemmer = function() { + + var step2list = { + ational: 'ate', + tional: 'tion', + enci: 'ence', + anci: 'ance', + izer: 'ize', + bli: 'ble', + alli: 'al', + entli: 'ent', + eli: 'e', + ousli: 'ous', + ization: 'ize', + ation: 'ate', + ator: 'ate', + alism: 'al', + iveness: 'ive', + fulness: 'ful', + ousness: 'ous', + aliti: 'al', + iviti: 'ive', + biliti: 'ble', + logi: 'log' + }; + + var step3list = { + icate: 'ic', + ative: '', + alize: 'al', + iciti: 'ic', + ical: 'ic', + ful: '', + ness: '' + }; + + var c = "[^aeiou]"; // consonant + var v = "[aeiouy]"; // vowel + var C = c + "[^aeiouy]*"; // consonant sequence + var V = v + "[aeiou]*"; // vowel sequence + + var mgr0 = "^(" + C + ")?" + V + C; // [C]VC... is m>0 + var meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$"; // [C]VC[V] is m=1 + var mgr1 = "^(" + C + ")?" + V + C + V + C; // [C]VCVC... is m>1 + var s_v = "^(" + C + ")?" + v; // vowel in stem + + this.stemWord = function (w) { + var stem; + var suffix; + var firstch; + var origword = w; + + if (w.length < 3) + return w; + + var re; + var re2; + var re3; + var re4; + + firstch = w.substr(0,1); + if (firstch == "y") + w = firstch.toUpperCase() + w.substr(1); + + // Step 1a + re = /^(.+?)(ss|i)es$/; + re2 = /^(.+?)([^s])s$/; + + if (re.test(w)) + w = w.replace(re,"$1$2"); + else if (re2.test(w)) + w = w.replace(re2,"$1$2"); + + // Step 1b + re = /^(.+?)eed$/; + re2 = /^(.+?)(ed|ing)$/; + if (re.test(w)) { + var fp = re.exec(w); + re = new RegExp(mgr0); + if (re.test(fp[1])) { + re = /.$/; + w = w.replace(re,""); + } + } + else if (re2.test(w)) { + var fp = re2.exec(w); + stem = fp[1]; + re2 = new RegExp(s_v); + if (re2.test(stem)) { + w = stem; + re2 = /(at|bl|iz)$/; + re3 = new RegExp("([^aeiouylsz])\\1$"); + re4 = new RegExp("^" + C + v + "[^aeiouwxy]$"); + if (re2.test(w)) + w = w + "e"; + else if (re3.test(w)) { + re = /.$/; + w = w.replace(re,""); + } + else if (re4.test(w)) + w = w + "e"; + } + } + + // Step 1c + re = /^(.+?)y$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(s_v); + if (re.test(stem)) + w = stem + "i"; + } + + // Step 2 + re = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + suffix = fp[2]; + re = new RegExp(mgr0); + if (re.test(stem)) + w = stem + step2list[suffix]; + } + + // Step 3 + re = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + suffix = fp[2]; + re = new RegExp(mgr0); + if (re.test(stem)) + w = stem + step3list[suffix]; + } + + // Step 4 + re = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/; + re2 = /^(.+?)(s|t)(ion)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(mgr1); + if (re.test(stem)) + w = stem; + } + else if (re2.test(w)) { + var fp = re2.exec(w); + stem = fp[1] + fp[2]; + re2 = new RegExp(mgr1); + if (re2.test(stem)) + w = stem; + } + + // Step 5 + re = /^(.+?)e$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(mgr1); + re2 = new RegExp(meq1); + re3 = new RegExp("^" + C + v + "[^aeiouwxy]$"); + if (re.test(stem) || (re2.test(stem) && !(re3.test(stem)))) + w = stem; + } + re = /ll$/; + re2 = new RegExp(mgr1); + if (re.test(w) && re2.test(w)) { + re = /.$/; + w = w.replace(re,""); + } + + // and turn initial Y back to y + if (firstch == "y") + w = firstch.toLowerCase() + w.substr(1); + return w; + } +} + diff --git a/docs/build/html/_static/minus.png b/docs/build/html/_static/minus.png new file mode 100644 index 0000000000000000000000000000000000000000..d96755fdaf8bb2214971e0db9c1fd3077d7c419d GIT binary patch literal 90 zcmeAS@N?(olHy`uVBq!ia0vp^+#t*WBp7;*Yy1LIik>cxAr*|t7R?Mi>2?kWtu=nj kDsEF_5m^0CR;1wuP-*O&G^0G}KYk!hp00i_>zopr08q^qX#fBK literal 0 HcmV?d00001 diff --git a/docs/build/html/_static/plus.png b/docs/build/html/_static/plus.png new file mode 100644 index 0000000000000000000000000000000000000000..7107cec93a979b9a5f64843235a16651d563ce2d GIT binary patch literal 90 zcmeAS@N?(olHy`uVBq!ia0vp^+#t*WBp7;*Yy1LIik>cxAr*|t7R?Mi>2?kWtu>-2 m3q%Vub%g%s<8sJhVPMczOq}xhg9DJoz~JfX=d#Wzp$Pyb1r*Kz literal 0 HcmV?d00001 diff --git a/docs/build/html/_static/pygments.css b/docs/build/html/_static/pygments.css new file mode 100644 index 0000000..04a4174 --- /dev/null +++ b/docs/build/html/_static/pygments.css @@ -0,0 +1,84 @@ +pre { line-height: 125%; } +td.linenos .normal { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; } +span.linenos { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; } +td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } +span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } +.highlight .hll { background-color: #ffffcc } +.highlight { background: #f8f8f8; } +.highlight .c { color: #8f5902; font-style: italic } /* Comment */ +.highlight .err { color: #a40000; border: 1px solid #ef2929 } /* Error */ +.highlight .g { color: #000000 } /* Generic */ +.highlight .k { color: #004461; font-weight: bold } /* Keyword */ +.highlight .l { color: #000000 } /* Literal */ +.highlight .n { color: #000000 } /* Name */ +.highlight .o { color: #582800 } /* Operator */ +.highlight .x { color: #000000 } /* Other */ +.highlight .p { color: #000000; font-weight: bold } /* Punctuation */ +.highlight .ch { color: #8f5902; font-style: italic } /* Comment.Hashbang */ +.highlight .cm { color: #8f5902; font-style: italic } /* Comment.Multiline */ +.highlight .cp { color: #8f5902 } /* Comment.Preproc */ +.highlight .cpf { color: #8f5902; font-style: italic } /* Comment.PreprocFile */ +.highlight .c1 { color: #8f5902; font-style: italic } /* Comment.Single */ +.highlight .cs { color: #8f5902; font-style: italic } /* Comment.Special */ +.highlight .gd { color: #a40000 } /* Generic.Deleted */ +.highlight .ge { color: #000000; font-style: italic } /* Generic.Emph */ +.highlight .ges { color: #000000 } /* Generic.EmphStrong */ +.highlight .gr { color: #ef2929 } /* Generic.Error */ +.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */ +.highlight .gi { color: #00A000 } /* Generic.Inserted */ +.highlight .go { color: #888888 } /* Generic.Output */ +.highlight .gp { color: #745334 } /* Generic.Prompt */ +.highlight .gs { color: #000000; font-weight: bold } /* Generic.Strong */ +.highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */ +.highlight .gt { color: #a40000; font-weight: bold } /* Generic.Traceback */ +.highlight .kc { color: #004461; font-weight: bold } /* Keyword.Constant */ +.highlight .kd { color: #004461; font-weight: bold } /* Keyword.Declaration */ +.highlight .kn { color: #004461; font-weight: bold } /* Keyword.Namespace */ +.highlight .kp { color: #004461; font-weight: bold } /* Keyword.Pseudo */ +.highlight .kr { color: #004461; font-weight: bold } /* Keyword.Reserved */ +.highlight .kt { color: #004461; font-weight: bold } /* Keyword.Type */ +.highlight .ld { color: #000000 } /* Literal.Date */ +.highlight .m { color: #990000 } /* Literal.Number */ +.highlight .s { color: #4e9a06 } /* Literal.String */ +.highlight .na { color: #c4a000 } /* Name.Attribute */ +.highlight .nb { color: #004461 } /* Name.Builtin */ +.highlight .nc { color: #000000 } /* Name.Class */ +.highlight .no { color: #000000 } /* Name.Constant */ +.highlight .nd { color: #888888 } /* Name.Decorator */ +.highlight .ni { color: #ce5c00 } /* Name.Entity */ +.highlight .ne { color: #cc0000; font-weight: bold } /* Name.Exception */ +.highlight .nf { color: #000000 } /* Name.Function */ +.highlight .nl { color: #f57900 } /* Name.Label */ +.highlight .nn { color: #000000 } /* Name.Namespace */ +.highlight .nx { color: #000000 } /* Name.Other */ +.highlight .py { color: #000000 } /* Name.Property */ +.highlight .nt { color: #004461; font-weight: bold } /* Name.Tag */ +.highlight .nv { color: #000000 } /* Name.Variable */ +.highlight .ow { color: #004461; font-weight: bold } /* Operator.Word */ +.highlight .pm { color: #000000; font-weight: bold } /* Punctuation.Marker */ +.highlight .w { color: #f8f8f8 } /* Text.Whitespace */ +.highlight .mb { color: #990000 } /* Literal.Number.Bin */ +.highlight .mf { color: #990000 } /* Literal.Number.Float */ +.highlight .mh { color: #990000 } /* Literal.Number.Hex */ +.highlight .mi { color: #990000 } /* Literal.Number.Integer */ +.highlight .mo { color: #990000 } /* Literal.Number.Oct */ +.highlight .sa { color: #4e9a06 } /* Literal.String.Affix */ +.highlight .sb { color: #4e9a06 } /* Literal.String.Backtick */ +.highlight .sc { color: #4e9a06 } /* Literal.String.Char */ +.highlight .dl { color: #4e9a06 } /* Literal.String.Delimiter */ +.highlight .sd { color: #8f5902; font-style: italic } /* Literal.String.Doc */ +.highlight .s2 { color: #4e9a06 } /* Literal.String.Double */ +.highlight .se { color: #4e9a06 } /* Literal.String.Escape */ +.highlight .sh { color: #4e9a06 } /* Literal.String.Heredoc */ +.highlight .si { color: #4e9a06 } /* Literal.String.Interpol */ +.highlight .sx { color: #4e9a06 } /* Literal.String.Other */ +.highlight .sr { color: #4e9a06 } /* Literal.String.Regex */ +.highlight .s1 { color: #4e9a06 } /* Literal.String.Single */ +.highlight .ss { color: #4e9a06 } /* Literal.String.Symbol */ +.highlight .bp { color: #3465a4 } /* Name.Builtin.Pseudo */ +.highlight .fm { color: #000000 } /* Name.Function.Magic */ +.highlight .vc { color: #000000 } /* Name.Variable.Class */ +.highlight .vg { color: #000000 } /* Name.Variable.Global */ +.highlight .vi { color: #000000 } /* Name.Variable.Instance */ +.highlight .vm { color: #000000 } /* Name.Variable.Magic */ +.highlight .il { color: #990000 } /* Literal.Number.Integer.Long */ \ No newline at end of file diff --git a/docs/build/html/_static/searchtools.js b/docs/build/html/_static/searchtools.js new file mode 100644 index 0000000..7918c3f --- /dev/null +++ b/docs/build/html/_static/searchtools.js @@ -0,0 +1,574 @@ +/* + * searchtools.js + * ~~~~~~~~~~~~~~~~ + * + * Sphinx JavaScript utilities for the full-text search. + * + * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ +"use strict"; + +/** + * Simple result scoring code. + */ +if (typeof Scorer === "undefined") { + var Scorer = { + // Implement the following function to further tweak the score for each result + // The function takes a result array [docname, title, anchor, descr, score, filename] + // and returns the new score. + /* + score: result => { + const [docname, title, anchor, descr, score, filename] = result + return score + }, + */ + + // query matches the full name of an object + objNameMatch: 11, + // or matches in the last dotted part of the object name + objPartialMatch: 6, + // Additive scores depending on the priority of the object + objPrio: { + 0: 15, // used to be importantResults + 1: 5, // used to be objectResults + 2: -5, // used to be unimportantResults + }, + // Used when the priority is not in the mapping. + objPrioDefault: 0, + + // query found in title + title: 15, + partialTitle: 7, + // query found in terms + term: 5, + partialTerm: 2, + }; +} + +const _removeChildren = (element) => { + while (element && element.lastChild) element.removeChild(element.lastChild); +}; + +/** + * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions#escaping + */ +const _escapeRegExp = (string) => + string.replace(/[.*+\-?^${}()|[\]\\]/g, "\\$&"); // $& means the whole matched string + +const _displayItem = (item, searchTerms, highlightTerms) => { + const docBuilder = DOCUMENTATION_OPTIONS.BUILDER; + const docFileSuffix = DOCUMENTATION_OPTIONS.FILE_SUFFIX; + const docLinkSuffix = DOCUMENTATION_OPTIONS.LINK_SUFFIX; + const showSearchSummary = DOCUMENTATION_OPTIONS.SHOW_SEARCH_SUMMARY; + const contentRoot = document.documentElement.dataset.content_root; + + const [docName, title, anchor, descr, score, _filename] = item; + + let listItem = document.createElement("li"); + let requestUrl; + let linkUrl; + if (docBuilder === "dirhtml") { + // dirhtml builder + let dirname = docName + "/"; + if (dirname.match(/\/index\/$/)) + dirname = dirname.substring(0, dirname.length - 6); + else if (dirname === "index/") dirname = ""; + requestUrl = contentRoot + dirname; + linkUrl = requestUrl; + } else { + // normal html builders + requestUrl = contentRoot + docName + docFileSuffix; + linkUrl = docName + docLinkSuffix; + } + let linkEl = listItem.appendChild(document.createElement("a")); + linkEl.href = linkUrl + anchor; + linkEl.dataset.score = score; + linkEl.innerHTML = title; + if (descr) { + listItem.appendChild(document.createElement("span")).innerHTML = + " (" + descr + ")"; + // highlight search terms in the description + if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js + highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted")); + } + else if (showSearchSummary) + fetch(requestUrl) + .then((responseData) => responseData.text()) + .then((data) => { + if (data) + listItem.appendChild( + Search.makeSearchSummary(data, searchTerms) + ); + // highlight search terms in the summary + if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js + highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted")); + }); + Search.output.appendChild(listItem); +}; +const _finishSearch = (resultCount) => { + Search.stopPulse(); + Search.title.innerText = _("Search Results"); + if (!resultCount) + Search.status.innerText = Documentation.gettext( + "Your search did not match any documents. Please make sure that all words are spelled correctly and that you've selected enough categories." + ); + else + Search.status.innerText = _( + `Search finished, found ${resultCount} page(s) matching the search query.` + ); +}; +const _displayNextItem = ( + results, + resultCount, + searchTerms, + highlightTerms, +) => { + // results left, load the summary and display it + // this is intended to be dynamic (don't sub resultsCount) + if (results.length) { + _displayItem(results.pop(), searchTerms, highlightTerms); + setTimeout( + () => _displayNextItem(results, resultCount, searchTerms, highlightTerms), + 5 + ); + } + // search finished, update title and status message + else _finishSearch(resultCount); +}; + +/** + * Default splitQuery function. Can be overridden in ``sphinx.search`` with a + * custom function per language. + * + * The regular expression works by splitting the string on consecutive characters + * that are not Unicode letters, numbers, underscores, or emoji characters. + * This is the same as ``\W+`` in Python, preserving the surrogate pair area. + */ +if (typeof splitQuery === "undefined") { + var splitQuery = (query) => query + .split(/[^\p{Letter}\p{Number}_\p{Emoji_Presentation}]+/gu) + .filter(term => term) // remove remaining empty strings +} + +/** + * Search Module + */ +const Search = { + _index: null, + _queued_query: null, + _pulse_status: -1, + + htmlToText: (htmlString) => { + const htmlElement = new DOMParser().parseFromString(htmlString, 'text/html'); + htmlElement.querySelectorAll(".headerlink").forEach((el) => { el.remove() }); + const docContent = htmlElement.querySelector('[role="main"]'); + if (docContent !== undefined) return docContent.textContent; + console.warn( + "Content block not found. Sphinx search tries to obtain it via '[role=main]'. Could you check your theme or template." + ); + return ""; + }, + + init: () => { + const query = new URLSearchParams(window.location.search).get("q"); + document + .querySelectorAll('input[name="q"]') + .forEach((el) => (el.value = query)); + if (query) Search.performSearch(query); + }, + + loadIndex: (url) => + (document.body.appendChild(document.createElement("script")).src = url), + + setIndex: (index) => { + Search._index = index; + if (Search._queued_query !== null) { + const query = Search._queued_query; + Search._queued_query = null; + Search.query(query); + } + }, + + hasIndex: () => Search._index !== null, + + deferQuery: (query) => (Search._queued_query = query), + + stopPulse: () => (Search._pulse_status = -1), + + startPulse: () => { + if (Search._pulse_status >= 0) return; + + const pulse = () => { + Search._pulse_status = (Search._pulse_status + 1) % 4; + Search.dots.innerText = ".".repeat(Search._pulse_status); + if (Search._pulse_status >= 0) window.setTimeout(pulse, 500); + }; + pulse(); + }, + + /** + * perform a search for something (or wait until index is loaded) + */ + performSearch: (query) => { + // create the required interface elements + const searchText = document.createElement("h2"); + searchText.textContent = _("Searching"); + const searchSummary = document.createElement("p"); + searchSummary.classList.add("search-summary"); + searchSummary.innerText = ""; + const searchList = document.createElement("ul"); + searchList.classList.add("search"); + + const out = document.getElementById("search-results"); + Search.title = out.appendChild(searchText); + Search.dots = Search.title.appendChild(document.createElement("span")); + Search.status = out.appendChild(searchSummary); + Search.output = out.appendChild(searchList); + + const searchProgress = document.getElementById("search-progress"); + // Some themes don't use the search progress node + if (searchProgress) { + searchProgress.innerText = _("Preparing search..."); + } + Search.startPulse(); + + // index already loaded, the browser was quick! + if (Search.hasIndex()) Search.query(query); + else Search.deferQuery(query); + }, + + /** + * execute search (requires search index to be loaded) + */ + query: (query) => { + const filenames = Search._index.filenames; + const docNames = Search._index.docnames; + const titles = Search._index.titles; + const allTitles = Search._index.alltitles; + const indexEntries = Search._index.indexentries; + + // stem the search terms and add them to the correct list + const stemmer = new Stemmer(); + const searchTerms = new Set(); + const excludedTerms = new Set(); + const highlightTerms = new Set(); + const objectTerms = new Set(splitQuery(query.toLowerCase().trim())); + splitQuery(query.trim()).forEach((queryTerm) => { + const queryTermLower = queryTerm.toLowerCase(); + + // maybe skip this "word" + // stopwords array is from language_data.js + if ( + stopwords.indexOf(queryTermLower) !== -1 || + queryTerm.match(/^\d+$/) + ) + return; + + // stem the word + let word = stemmer.stemWord(queryTermLower); + // select the correct list + if (word[0] === "-") excludedTerms.add(word.substr(1)); + else { + searchTerms.add(word); + highlightTerms.add(queryTermLower); + } + }); + + if (SPHINX_HIGHLIGHT_ENABLED) { // set in sphinx_highlight.js + localStorage.setItem("sphinx_highlight_terms", [...highlightTerms].join(" ")) + } + + // console.debug("SEARCH: searching for:"); + // console.info("required: ", [...searchTerms]); + // console.info("excluded: ", [...excludedTerms]); + + // array of [docname, title, anchor, descr, score, filename] + let results = []; + _removeChildren(document.getElementById("search-progress")); + + const queryLower = query.toLowerCase(); + for (const [title, foundTitles] of Object.entries(allTitles)) { + if (title.toLowerCase().includes(queryLower) && (queryLower.length >= title.length/2)) { + for (const [file, id] of foundTitles) { + let score = Math.round(100 * queryLower.length / title.length) + results.push([ + docNames[file], + titles[file] !== title ? `${titles[file]} > ${title}` : title, + id !== null ? "#" + id : "", + null, + score, + filenames[file], + ]); + } + } + } + + // search for explicit entries in index directives + for (const [entry, foundEntries] of Object.entries(indexEntries)) { + if (entry.includes(queryLower) && (queryLower.length >= entry.length/2)) { + for (const [file, id] of foundEntries) { + let score = Math.round(100 * queryLower.length / entry.length) + results.push([ + docNames[file], + titles[file], + id ? "#" + id : "", + null, + score, + filenames[file], + ]); + } + } + } + + // lookup as object + objectTerms.forEach((term) => + results.push(...Search.performObjectSearch(term, objectTerms)) + ); + + // lookup as search terms in fulltext + results.push(...Search.performTermsSearch(searchTerms, excludedTerms)); + + // let the scorer override scores with a custom scoring function + if (Scorer.score) results.forEach((item) => (item[4] = Scorer.score(item))); + + // now sort the results by score (in opposite order of appearance, since the + // display function below uses pop() to retrieve items) and then + // alphabetically + results.sort((a, b) => { + const leftScore = a[4]; + const rightScore = b[4]; + if (leftScore === rightScore) { + // same score: sort alphabetically + const leftTitle = a[1].toLowerCase(); + const rightTitle = b[1].toLowerCase(); + if (leftTitle === rightTitle) return 0; + return leftTitle > rightTitle ? -1 : 1; // inverted is intentional + } + return leftScore > rightScore ? 1 : -1; + }); + + // remove duplicate search results + // note the reversing of results, so that in the case of duplicates, the highest-scoring entry is kept + let seen = new Set(); + results = results.reverse().reduce((acc, result) => { + let resultStr = result.slice(0, 4).concat([result[5]]).map(v => String(v)).join(','); + if (!seen.has(resultStr)) { + acc.push(result); + seen.add(resultStr); + } + return acc; + }, []); + + results = results.reverse(); + + // for debugging + //Search.lastresults = results.slice(); // a copy + // console.info("search results:", Search.lastresults); + + // print the results + _displayNextItem(results, results.length, searchTerms, highlightTerms); + }, + + /** + * search for object names + */ + performObjectSearch: (object, objectTerms) => { + const filenames = Search._index.filenames; + const docNames = Search._index.docnames; + const objects = Search._index.objects; + const objNames = Search._index.objnames; + const titles = Search._index.titles; + + const results = []; + + const objectSearchCallback = (prefix, match) => { + const name = match[4] + const fullname = (prefix ? prefix + "." : "") + name; + const fullnameLower = fullname.toLowerCase(); + if (fullnameLower.indexOf(object) < 0) return; + + let score = 0; + const parts = fullnameLower.split("."); + + // check for different match types: exact matches of full name or + // "last name" (i.e. last dotted part) + if (fullnameLower === object || parts.slice(-1)[0] === object) + score += Scorer.objNameMatch; + else if (parts.slice(-1)[0].indexOf(object) > -1) + score += Scorer.objPartialMatch; // matches in last name + + const objName = objNames[match[1]][2]; + const title = titles[match[0]]; + + // If more than one term searched for, we require other words to be + // found in the name/title/description + const otherTerms = new Set(objectTerms); + otherTerms.delete(object); + if (otherTerms.size > 0) { + const haystack = `${prefix} ${name} ${objName} ${title}`.toLowerCase(); + if ( + [...otherTerms].some((otherTerm) => haystack.indexOf(otherTerm) < 0) + ) + return; + } + + let anchor = match[3]; + if (anchor === "") anchor = fullname; + else if (anchor === "-") anchor = objNames[match[1]][1] + "-" + fullname; + + const descr = objName + _(", in ") + title; + + // add custom score for some objects according to scorer + if (Scorer.objPrio.hasOwnProperty(match[2])) + score += Scorer.objPrio[match[2]]; + else score += Scorer.objPrioDefault; + + results.push([ + docNames[match[0]], + fullname, + "#" + anchor, + descr, + score, + filenames[match[0]], + ]); + }; + Object.keys(objects).forEach((prefix) => + objects[prefix].forEach((array) => + objectSearchCallback(prefix, array) + ) + ); + return results; + }, + + /** + * search for full-text terms in the index + */ + performTermsSearch: (searchTerms, excludedTerms) => { + // prepare search + const terms = Search._index.terms; + const titleTerms = Search._index.titleterms; + const filenames = Search._index.filenames; + const docNames = Search._index.docnames; + const titles = Search._index.titles; + + const scoreMap = new Map(); + const fileMap = new Map(); + + // perform the search on the required terms + searchTerms.forEach((word) => { + const files = []; + const arr = [ + { files: terms[word], score: Scorer.term }, + { files: titleTerms[word], score: Scorer.title }, + ]; + // add support for partial matches + if (word.length > 2) { + const escapedWord = _escapeRegExp(word); + Object.keys(terms).forEach((term) => { + if (term.match(escapedWord) && !terms[word]) + arr.push({ files: terms[term], score: Scorer.partialTerm }); + }); + Object.keys(titleTerms).forEach((term) => { + if (term.match(escapedWord) && !titleTerms[word]) + arr.push({ files: titleTerms[word], score: Scorer.partialTitle }); + }); + } + + // no match but word was a required one + if (arr.every((record) => record.files === undefined)) return; + + // found search word in contents + arr.forEach((record) => { + if (record.files === undefined) return; + + let recordFiles = record.files; + if (recordFiles.length === undefined) recordFiles = [recordFiles]; + files.push(...recordFiles); + + // set score for the word in each file + recordFiles.forEach((file) => { + if (!scoreMap.has(file)) scoreMap.set(file, {}); + scoreMap.get(file)[word] = record.score; + }); + }); + + // create the mapping + files.forEach((file) => { + if (fileMap.has(file) && fileMap.get(file).indexOf(word) === -1) + fileMap.get(file).push(word); + else fileMap.set(file, [word]); + }); + }); + + // now check if the files don't contain excluded terms + const results = []; + for (const [file, wordList] of fileMap) { + // check if all requirements are matched + + // as search terms with length < 3 are discarded + const filteredTermCount = [...searchTerms].filter( + (term) => term.length > 2 + ).length; + if ( + wordList.length !== searchTerms.size && + wordList.length !== filteredTermCount + ) + continue; + + // ensure that none of the excluded terms is in the search result + if ( + [...excludedTerms].some( + (term) => + terms[term] === file || + titleTerms[term] === file || + (terms[term] || []).includes(file) || + (titleTerms[term] || []).includes(file) + ) + ) + break; + + // select one (max) score for the file. + const score = Math.max(...wordList.map((w) => scoreMap.get(file)[w])); + // add result to the result list + results.push([ + docNames[file], + titles[file], + "", + null, + score, + filenames[file], + ]); + } + return results; + }, + + /** + * helper function to return a node containing the + * search summary for a given text. keywords is a list + * of stemmed words. + */ + makeSearchSummary: (htmlText, keywords) => { + const text = Search.htmlToText(htmlText); + if (text === "") return null; + + const textLower = text.toLowerCase(); + const actualStartPosition = [...keywords] + .map((k) => textLower.indexOf(k.toLowerCase())) + .filter((i) => i > -1) + .slice(-1)[0]; + const startWithContext = Math.max(actualStartPosition - 120, 0); + + const top = startWithContext === 0 ? "" : "..."; + const tail = startWithContext + 240 < text.length ? "..." : ""; + + let summary = document.createElement("p"); + summary.classList.add("context"); + summary.textContent = top + text.substr(startWithContext, 240).trim() + tail; + + return summary; + }, +}; + +_ready(Search.init); diff --git a/docs/build/html/_static/sphinx_highlight.js b/docs/build/html/_static/sphinx_highlight.js new file mode 100644 index 0000000..8a96c69 --- /dev/null +++ b/docs/build/html/_static/sphinx_highlight.js @@ -0,0 +1,154 @@ +/* Highlighting utilities for Sphinx HTML documentation. */ +"use strict"; + +const SPHINX_HIGHLIGHT_ENABLED = true + +/** + * highlight a given string on a node by wrapping it in + * span elements with the given class name. + */ +const _highlight = (node, addItems, text, className) => { + if (node.nodeType === Node.TEXT_NODE) { + const val = node.nodeValue; + const parent = node.parentNode; + const pos = val.toLowerCase().indexOf(text); + if ( + pos >= 0 && + !parent.classList.contains(className) && + !parent.classList.contains("nohighlight") + ) { + let span; + + const closestNode = parent.closest("body, svg, foreignObject"); + const isInSVG = closestNode && closestNode.matches("svg"); + if (isInSVG) { + span = document.createElementNS("http://www.w3.org/2000/svg", "tspan"); + } else { + span = document.createElement("span"); + span.classList.add(className); + } + + span.appendChild(document.createTextNode(val.substr(pos, text.length))); + const rest = document.createTextNode(val.substr(pos + text.length)); + parent.insertBefore( + span, + parent.insertBefore( + rest, + node.nextSibling + ) + ); + node.nodeValue = val.substr(0, pos); + /* There may be more occurrences of search term in this node. So call this + * function recursively on the remaining fragment. + */ + _highlight(rest, addItems, text, className); + + if (isInSVG) { + const rect = document.createElementNS( + "http://www.w3.org/2000/svg", + "rect" + ); + const bbox = parent.getBBox(); + rect.x.baseVal.value = bbox.x; + rect.y.baseVal.value = bbox.y; + rect.width.baseVal.value = bbox.width; + rect.height.baseVal.value = bbox.height; + rect.setAttribute("class", className); + addItems.push({ parent: parent, target: rect }); + } + } + } else if (node.matches && !node.matches("button, select, textarea")) { + node.childNodes.forEach((el) => _highlight(el, addItems, text, className)); + } +}; +const _highlightText = (thisNode, text, className) => { + let addItems = []; + _highlight(thisNode, addItems, text, className); + addItems.forEach((obj) => + obj.parent.insertAdjacentElement("beforebegin", obj.target) + ); +}; + +/** + * Small JavaScript module for the documentation. + */ +const SphinxHighlight = { + + /** + * highlight the search words provided in localstorage in the text + */ + highlightSearchWords: () => { + if (!SPHINX_HIGHLIGHT_ENABLED) return; // bail if no highlight + + // get and clear terms from localstorage + const url = new URL(window.location); + const highlight = + localStorage.getItem("sphinx_highlight_terms") + || url.searchParams.get("highlight") + || ""; + localStorage.removeItem("sphinx_highlight_terms") + url.searchParams.delete("highlight"); + window.history.replaceState({}, "", url); + + // get individual terms from highlight string + const terms = highlight.toLowerCase().split(/\s+/).filter(x => x); + if (terms.length === 0) return; // nothing to do + + // There should never be more than one element matching "div.body" + const divBody = document.querySelectorAll("div.body"); + const body = divBody.length ? divBody[0] : document.querySelector("body"); + window.setTimeout(() => { + terms.forEach((term) => _highlightText(body, term, "highlighted")); + }, 10); + + const searchBox = document.getElementById("searchbox"); + if (searchBox === null) return; + searchBox.appendChild( + document + .createRange() + .createContextualFragment( + '

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

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

Index

+ +
+ +
+ + +
+ +
+
+ +
+
+
+ ©2024, Ali Nwegy. + + | + Powered by Sphinx 7.2.6 + & Alabaster 0.7.16 + +
+ + + + + + \ No newline at end of file diff --git a/docs/build/html/index.html b/docs/build/html/index.html new file mode 100644 index 0000000..83c8fb3 --- /dev/null +++ b/docs/build/html/index.html @@ -0,0 +1,111 @@ + + + + + + + + Welcome to fn_gen’s documentation! — fn_gen "0.0.1" documentation + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

Welcome to fn_gen’s documentation!

+

fn_gen (/ˈfʌŋkʃən ˈʤɛnəˌreɪtər/) is a Python library for usage with SCPI (Simple Command Protocol for measurement Instruments) compliant function generators.

+
+
+
+
+

Indices and tables

+ +
+ + +
+ +
+
+ +
+
+
+ ©2024, Ali Nwegy. + + | + Powered by Sphinx 7.2.6 + & Alabaster 0.7.16 + + | + Page source +
+ + + + + + \ No newline at end of file diff --git a/docs/build/html/objects.inv b/docs/build/html/objects.inv new file mode 100644 index 0000000000000000000000000000000000000000..b833ae8d441275dc791fe26b093c71617eec103b GIT binary patch literal 253 zcmY#Z2rkIT%&Sny%qvUHE6FdaR47X=D$dN$Q!wIERtPA{&q_@$u~JCOi%(C@1B!$} zWUUl{?2wF9g`(8l#LT>u)FOraG=-9k%wmPK%$!sOAf23_TTql*T%4MsP+FXsm#$Ei zlbNK)RdLJP|Lo~A-kxg%H1s?-p7QkZIvaSwG{mF5>s9KMC(kr0nr6gsq-y>=so?6N zbtt%a(&yq}QLj&;mp(me+$C>%MkkD6mG)WRv)Z0IC(oP@esb!p|G}hC$EA8cOi9!7 y>%21kw5|lHL^9oC((*R?^f{nZe7TyKYWjk#mJY`+EY44ug)Rs0WccD4Zw>(QL1p3q literal 0 HcmV?d00001 diff --git a/docs/build/html/search.html b/docs/build/html/search.html new file mode 100644 index 0000000..a89d893 --- /dev/null +++ b/docs/build/html/search.html @@ -0,0 +1,118 @@ + + + + + + + Search — fn_gen "0.0.1" documentation + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +

Search

+ + + + +

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

+ + +
+ + + +
+ + + +
+ +
+ + +
+ +
+
+ +
+
+
+ ©2024, Ali Nwegy. + + | + Powered by Sphinx 7.2.6 + & Alabaster 0.7.16 + +
+ + + + + + \ No newline at end of file diff --git a/docs/build/html/searchindex.js b/docs/build/html/searchindex.js new file mode 100644 index 0000000..61f7cc1 --- /dev/null +++ b/docs/build/html/searchindex.js @@ -0,0 +1 @@ +Search.setIndex({"docnames": ["index"], "filenames": ["index.rst"], "titles": ["Welcome to fn_gen\u2019s documentation!"], "terms": {"index": 0, "modul": 0, "search": 0, "page": 0, "\u02c8f\u028c\u014bk\u0283\u0259n": 0, "\u02c8\u02a4\u025bn\u0259\u02ccre\u026at\u0259r": 0, "i": 0, "python": 0, "librari": 0, "usag": 0, "scpi": 0, "simpl": 0, "command": 0, "protocol": 0, "measur": 0, "instrument": 0, "compliant": 0, "function": 0, "gener": 0}, "objects": {}, "objtypes": {}, "objnames": {}, "titleterms": {"welcom": 0, "fn_gen": 0, "": 0, "document": 0, "indic": 0, "tabl": 0}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx": 60}, "alltitles": {"Welcome to fn_gen\u2019s documentation!": [[0, "welcome-to-fn-gen-s-documentation"]], "Indices and tables": [[0, "indices-and-tables"]]}, "indexentries": {}}) \ No newline at end of file diff --git a/docs/build/index.html b/docs/build/index.html new file mode 100644 index 0000000..786c6c2 --- /dev/null +++ b/docs/build/index.html @@ -0,0 +1,124 @@ + + + + + + + + Welcome to fn_gen’s documentation! — fn_gen "0.0.1" documentation + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

Welcome to fn_gen’s documentation!

+

fn_gen (/ˈfʌŋkʃən ˈʤɛnəˌreɪtər/) is a Python library for usage with SCPI (Simple Command Protocol for measurement Instruments) compliant function generators.

+
+

Contents:

+ +
+
+
+

Indices and tables

+ +
+ + +
+ +
+
+ +
+
+
+ ©2024, Ali Nwegy. + + | + Powered by Sphinx 7.2.6 + & Alabaster 0.7.16 + + | + Page source +
+ + + + + + \ No newline at end of file diff --git a/docs/build/index/usage.html b/docs/build/index/usage.html new file mode 100644 index 0000000..245980d --- /dev/null +++ b/docs/build/index/usage.html @@ -0,0 +1,110 @@ + + + + + + + + Usage — fn_gen "0.0.1" documentation + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

Usage

+
+

Installation

+

To use fn_gen, you need to first build it using python build:

+
(.venv) $ pip install build
+(.venv) $ python -m build
+(.venv) $ deactivate
+$ pip install dist/fn_gen-0.0.1-py3-none-any.whl
+
+
+
+
+ + +
+ +
+
+ +
+
+
+ ©2024, Ali Nwegy. + + | + Powered by Sphinx 7.2.6 + & Alabaster 0.7.16 + + | + Page source +
+ + + + + + \ No newline at end of file diff --git a/docs/build/objects.inv b/docs/build/objects.inv new file mode 100644 index 0000000000000000000000000000000000000000..d9af23e2c2ac32ca30623d515c354b5f0ced5148 GIT binary patch literal 267 zcmY#Z2rkIT%&Sny%qvUHE6FdaR47X=D$dN$Q!wIERtPA{&q_@$u~JCOi%(C@1B!$} zWUUl{?2wF9g`(8l#LT>u)FOraG=-9k%wmPK%$!sOAf23_TTql*T%4MsP+FXsm#$Ei zlbNK)RdLJP|Lo~A-kxg%H1s?-p7QkZIvaSwG{mF5>s9KMC(kr0nr6gsq-y>=so?6N zbtt%a(&yq}QLj&;mp(me+$C>%MkkD6mG)WRv)Z0IC(oP@esb!p|G}hC$EA8cOi9!7 z>%21kw5|lHL^9oC((*R?^f{nZe7TyKYWjk#mJY`+EY44ug)Rs0^y+R@+4TJYlR)W0 M1vPPo?BiK?0JGX_?*IS* literal 0 HcmV?d00001 diff --git a/docs/build/search.html b/docs/build/search.html new file mode 100644 index 0000000..0c87e4b --- /dev/null +++ b/docs/build/search.html @@ -0,0 +1,122 @@ + + + + + + + Search — fn_gen "0.0.1" documentation + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +

Search

+ + + + +

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

+ + +
+ + + +
+ + + +
+ +
+ + +
+ +
+
+ +
+
+
+ ©2024, Ali Nwegy. + + | + Powered by Sphinx 7.2.6 + & Alabaster 0.7.16 + +
+ + + + + + \ No newline at end of file diff --git a/docs/build/searchindex.js b/docs/build/searchindex.js new file mode 100644 index 0000000..d0826d9 --- /dev/null +++ b/docs/build/searchindex.js @@ -0,0 +1 @@ +Search.setIndex({"docnames": ["index", "usage"], "filenames": ["index.rst", "usage.rst"], "titles": ["Welcome to fn_gen\u2019s documentation!", "Usage"], "terms": {"\u02c8f\u028c\u014bk\u0283\u0259n": 0, "\u02c8\u02a4\u025bn\u0259\u02ccre\u026at\u0259r": 0, "i": 0, "python": [0, 1], "librari": 0, "usag": 0, "scpi": 0, "simpl": 0, "command": 0, "protocol": 0, "measur": 0, "instrument": 0, "compliant": 0, "function": 0, "gener": 0, "index": 0, "modul": 0, "search": 0, "page": 0, "To": 1, "us": 1, "fn_gen": 1, "you": 1, "need": 1, "first": 1, "build": 1, "venv": 1, "pip": 1, "m": 1, "deactiv": 1, "dist": 1, "0": 1, "1": 1, "py3": 1, "none": 1, "ani": 1, "whl": 1, "instal": 0}, "objects": {}, "objtypes": {}, "objnames": {}, "titleterms": {"welcom": 0, "fn_gen": 0, "": 0, "document": 0, "indic": 0, "tabl": 0, "usag": 1, "instal": 1, "content": 0}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx": 60}, "alltitles": {"Welcome to fn_gen\u2019s documentation!": [[0, "welcome-to-fn-gen-s-documentation"]], "Contents:": [[0, null]], "Indices and tables": [[0, "indices-and-tables"]], "Usage": [[1, "usage"]], "Installation": [[1, "installation"]]}, "indexentries": {}}) \ No newline at end of file diff --git a/docs/build/usage.html b/docs/build/usage.html new file mode 100644 index 0000000..dbb1522 --- /dev/null +++ b/docs/build/usage.html @@ -0,0 +1,119 @@ + + + + + + + + Usage — fn_gen "0.0.1" documentation + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

Usage

+
+

Installation

+

To use fn_gen, you need to first build it using python build:

+
(.venv) $ pip install build
+(.venv) $ python -m build
+(.venv) $ deactivate
+$ pip install dist/fn_gen-0.0.1-py3-none-any.whl
+
+
+
+
+ + +
+ +
+
+ +
+
+
+ ©2024, Ali Nwegy. + + | + Powered by Sphinx 7.2.6 + & Alabaster 0.7.16 + + | + Page source +
+ + + + + + \ No newline at end of file diff --git a/docs/build/usage/index.html b/docs/build/usage/index.html new file mode 100644 index 0000000..f5adcce --- /dev/null +++ b/docs/build/usage/index.html @@ -0,0 +1,110 @@ + + + + + + + + Usage — fn_gen "0.0.1" documentation + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

Usage

+
+

Installation

+

To use fn_gen, you need to first build it using python build:

+
(.venv) $ pip install build
+(.venv) $ python -m build
+(.venv) $ deactivate
+$ pip install dist/fn_gen-0.0.1-py3-none-any.whl
+
+
+
+
+ + +
+ +
+
+ +
+
+
+ ©2024, Ali Nwegy. + + | + Powered by Sphinx 7.2.6 + & Alabaster 0.7.16 + + | + Page source +
+ + + + + + \ No newline at end of file diff --git a/docs/make.bat b/docs/make.bat new file mode 100644 index 0000000..747ffb7 --- /dev/null +++ b/docs/make.bat @@ -0,0 +1,35 @@ +@ECHO OFF + +pushd %~dp0 + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set SOURCEDIR=source +set BUILDDIR=build + +%SPHINXBUILD% >NUL 2>NUL +if errorlevel 9009 ( + echo. + echo.The 'sphinx-build' command was not found. Make sure you have Sphinx + echo.installed, then set the SPHINXBUILD environment variable to point + echo.to the full path of the 'sphinx-build' executable. Alternatively you + echo.may add the Sphinx directory to PATH. + echo. + echo.If you don't have Sphinx installed, grab it from + echo.https://www.sphinx-doc.org/ + exit /b 1 +) + +if "%1" == "" goto help + +%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% +goto end + +:help +%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% + +:end +popd diff --git a/docs/source/conf.py b/docs/source/conf.py new file mode 100644 index 0000000..c0adb7a --- /dev/null +++ b/docs/source/conf.py @@ -0,0 +1,28 @@ +# 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 = 'fn_gen' +copyright = '2024, Ali Nwegy' +author = 'Ali Nwegy' +release = '"0.0.1"' + +# -- General configuration --------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration + +extensions = [] + +templates_path = ['_templates'] +exclude_patterns = [] + + + +# -- Options for HTML output ------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output + +html_theme = 'alabaster' +html_static_path = ['_static'] diff --git a/docs/source/index.rst b/docs/source/index.rst new file mode 100644 index 0000000..55317c3 --- /dev/null +++ b/docs/source/index.rst @@ -0,0 +1,24 @@ +.. fn_gen documentation master file, created by + sphinx-quickstart on Tue Jan 16 17:51:58 2024. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to fn_gen's documentation! +================================== + +**fn_gen** (/ˈfʌŋkʃən ˈʤɛnəˌreɪtər/) is a Python library for usage with SCPI (Simple Command Protocol for measurement Instruments) compliant function generators. + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + usage + + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/docs/source/usage.rst b/docs/source/usage.rst new file mode 100644 index 0000000..5d7bcfd --- /dev/null +++ b/docs/source/usage.rst @@ -0,0 +1,16 @@ +Usage +===== + +Installation +------------ + +To use fn_gen, you need to first build it using python build: + +.. code-block:: console + + (.venv) $ pip install build + (.venv) $ python -m build + (.venv) $ deactivate + $ pip install dist/fn_gen-0.0.1-py3-none-any.whl + + diff --git a/examples/dc_signal.py b/examples/dc_signal.py new file mode 100644 index 0000000..5638a67 --- /dev/null +++ b/examples/dc_signal.py @@ -0,0 +1,28 @@ +from fn_gen import DG2052 +from fn_gen.enums import OutputChannel +import fn_gen.errors as fg_err +import logging +import time + +if __name__ == "__main__": + try: + # logging.basicConfig(filename="dg2052.log", encoding="utf-8", level=logging.DEBUG) + fn_gen = DG2052("TCPIP::192.168.1.11::INSTR") + channel = OutputChannel.TWO + print(fn_gen.whoami()) + print( f"\nOutput{channel.value} Impedance: {fn_gen.get_output_impedance(channel)} Ohm" ) + print( f"Output{channel.value} Load: {fn_gen.get_output_load(channel)} Ohm" ) + print( f"Output{channel.value} Voltage Limits: {fn_gen.get_output_volt_limits(channel)} V" ) + fn_gen.set_dc(channel, 10) + print( f"Output{channel.value}: {fn_gen.get_output_signal(channel)} | {fn_gen.get_output_state(channel)}" ) + fn_gen.set_output(channel, True) + print( f"Output{channel.value} State: {fn_gen.get_output_state(channel)}" ) + time.sleep(5) + fn_gen.set_output(channel, False) + print( f"Output{channel.value} State: {fn_gen.get_output_state(channel)}" ) + except fg_err.UndefinedCommunicationMethodError as err: + print(err) + except fg_err.ValueOutOfBoundsError as err: + print(err) + except fg_err.UndefinedValueError as err: + print(err) diff --git a/examples/ramp_signal.py b/examples/ramp_signal.py new file mode 100644 index 0000000..9173b18 --- /dev/null +++ b/examples/ramp_signal.py @@ -0,0 +1,29 @@ +from fn_gen import DG2052 +from fn_gen.enums import OutputChannel +import fn_gen.errors as fg_err +import logging +import time + +if __name__ == "__main__": + try: + # logging.basicConfig(filename="dg2052.log", encoding="utf-8", level=logging.DEBUG) + fn_gen = DG2052("TCPIP::192.168.1.11::INSTR") + channel = OutputChannel.TWO + print(fn_gen.whoami()) + print( f"\nOutput{channel.value} Impedance: {fn_gen.get_output_impedance(channel)} Ohm" ) + print( f"Output{channel.value} Load: {fn_gen.get_output_load(channel)} Ohm" ) + print( f"Output{channel.value} Voltage Limits: {fn_gen.get_output_volt_limits(channel)} V" ) + fn_gen.set_ramp(channel, 500, 2.5, 0, 0) + print( f"Output{channel.value}: {fn_gen.get_output_signal(channel)} | {fn_gen.get_output_state(channel)}" ) + fn_gen.set_output(channel, True) + print( f"Output{channel.value} State: {fn_gen.get_output_state(channel)}" ) + time.sleep(5) + fn_gen.set_output(channel, False) + print( f"Output{channel.value} State: {fn_gen.get_output_state(channel)}" ) + except fg_err.UndefinedCommunicationMethodError as err: + print(err) + except fg_err.ValueOutOfBoundsError as err: + print(err) + except fg_err.UndefinedValueError as err: + print(err) + diff --git a/examples/sine_signal.py b/examples/sine_signal.py new file mode 100644 index 0000000..439265b --- /dev/null +++ b/examples/sine_signal.py @@ -0,0 +1,28 @@ +from fn_gen import DG2052 +from fn_gen.enums import OutputChannel +import fn_gen.errors as fg_err +import logging +import time + +if __name__ == "__main__": + try: + # logging.basicConfig(filename="dg2052.log", encoding="utf-8", level=logging.DEBUG) + fn_gen = DG2052("TCPIP::192.168.1.11::INSTR") + channel = OutputChannel.TWO + print(fn_gen.whoami()) + print( f"\nOutput{channel.value} Impedance: {fn_gen.get_output_impedance(channel)} Ohm" ) + print( f"Output{channel.value} Load: {fn_gen.get_output_load(channel)} Ohm" ) + print( f"Output{channel.value} Voltage Limits: {fn_gen.get_output_volt_limits(channel)} V" ) + fn_gen.set_sine_wave(channel, 500, 2.5, 0, 0) + print( f"Output{channel.value}: {fn_gen.get_output_signal(channel)} | {fn_gen.get_output_state(channel)}" ) + fn_gen.set_output(channel, True) + print( f"Output{channel.value} State: {fn_gen.get_output_state(channel)}" ) + time.sleep(5) + fn_gen.set_output(channel, False) + print( f"Output{channel.value} State: {fn_gen.get_output_state(channel)}" ) + except fg_err.UndefinedCommunicationMethodError as err: + print(err) + except fg_err.ValueOutOfBoundsError as err: + print(err) + except fg_err.UndefinedValueError as err: + print(err) diff --git a/examples/square_signal.py b/examples/square_signal.py new file mode 100644 index 0000000..f413365 --- /dev/null +++ b/examples/square_signal.py @@ -0,0 +1,28 @@ +from fn_gen import DG2052 +from fn_gen.enums import OutputChannel +import fn_gen.errors as fg_err +import logging +import time + +if __name__ == "__main__": + try: + # logging.basicConfig(filename="dg2052.log", encoding="utf-8", level=logging.DEBUG) + fn_gen = DG2052("TCPIP::192.168.1.11::INSTR") + channel = OutputChannel.TWO + print(fn_gen.whoami()) + print( f"\nOutput{channel.value} Impedance: {fn_gen.get_output_impedance(channel)} Ohm" ) + print( f"Output{channel.value} Load: {fn_gen.get_output_load(channel)} Ohm" ) + print( f"Output{channel.value} Voltage Limits: {fn_gen.get_output_volt_limits(channel)} V" ) + fn_gen.set_square_wave(channel, 500, 2.5, 0, 0) + print( f"Output{channel.value}: {fn_gen.get_output_signal(channel)} | {fn_gen.get_output_state(channel)}" ) + fn_gen.set_output(channel, True) + print( f"Output{channel.value} State: {fn_gen.get_output_state(channel)}" ) + time.sleep(5) + fn_gen.set_output(channel, False) + print( f"Output{channel.value} State: {fn_gen.get_output_state(channel)}" ) + except fg_err.UndefinedCommunicationMethodError as err: + print(err) + except fg_err.ValueOutOfBoundsError as err: + print(err) + except fg_err.UndefinedValueError as err: + print(err) diff --git a/examples/sweep.py b/examples/sweep.py new file mode 100644 index 0000000..d8886cf --- /dev/null +++ b/examples/sweep.py @@ -0,0 +1,28 @@ +from fn_gen import DG2052 +from fn_gen.enums import OutputChannel, SweepSpacing +import fn_gen.errors as fg_err +import logging +import time + +if __name__ == "__main__": + try: + # logging.basicConfig(filename="dg2052.log", encoding="utf-8", level=logging.DEBUG) + fn_gen = DG2052("TCPIP::192.168.1.11::INSTR") + channel = OutputChannel.TWO + print(fn_gen.whoami()) + print( f"\nOutput{channel.value} Impedance: {fn_gen.get_output_impedance(channel)} Ohm" ) + print( f"Output{channel.value} Load: {fn_gen.get_output_load(channel)} Ohm" ) + print( f"Output{channel.value} Voltage Limits: {fn_gen.get_output_volt_limits(channel)} V" ) + fn_gen.set_sweep(channel, htime_start=1, htime_stop=1, time=10, spacing=SweepSpacing.LOG) + print( f"Output{channel.value}: {fn_gen.get_output_signal(channel)} | {fn_gen.get_output_state(channel)}" ) + fn_gen.set_output(channel, True) + print( f"Output{channel.value} State: {fn_gen.get_output_state(channel)}" ) + time.sleep(20) + fn_gen.set_output(channel, False) + print( f"Output{channel.value} State: {fn_gen.get_output_state(channel)}" ) + except fg_err.UndefinedCommunicationMethodError as err: + print(err) + except fg_err.ValueOutOfBoundsError as err: + print(err) + except fg_err.UndefinedValueError as err: + print(err) diff --git a/examples/whoami.py b/examples/whoami.py new file mode 100644 index 0000000..9275f84 --- /dev/null +++ b/examples/whoami.py @@ -0,0 +1,15 @@ +import pyvisa +import sys +from fn_gen import DG2052 + +if __name__ == "__main__": + rm = pyvisa.ResourceManager() + resources = rm.list_resources() # list available resources + if len(resources) == 0: + print("No Resources Found!") + sys.exit(1) + else: + print(f"Available Resources: {resources}") + port = resources[0] # Select the first resource + inst = DG2052(port) + print(inst.whoami()) diff --git a/fn_gen/dg2052.py b/fn_gen/dg2052.py index 9a1584c..f2a5c26 100644 --- a/fn_gen/dg2052.py +++ b/fn_gen/dg2052.py @@ -133,9 +133,16 @@ class DG2052( pyvisa.resources.MessageBasedResource ): def set_sweep( self, channel: OutputChannel, # Sets the output channel of the sweep function + amp: float = 5, # Sets the amplitude of the sweeped signal + offset: float = 0, # Sets the offset voltage of the sweeped signal + phase: int = 0, # Sets the phase shift of the sweeped signal signal_type: SweepSignalType = SweepSignalType.SINE, # Sets the type of signal being sweeped htime_start: float = 0, # Sets the start hold time of the sweep function htime_stop: float = 0, # Sets the stop hold time of the sweep function + freq_start: float = 100, # Sets the sweep starting frequency + freq_stop: float = 1e3, # Sets the sweep stopping frequency + marker: bool = False, # Enables/Disables setting the marker frequency manually + freq_marker: float = 550, # Sets the marker frequency at whic the Sync signal changes from high to low rtime: float = 0, # Sets the return time of the sweep function time: float = 1, # Sets the sweep time spacing: SweepSpacing = SweepSpacing.LIN, # Sets the sweep type @@ -150,6 +157,20 @@ class DG2052( pyvisa.resources.MessageBasedResource ): check_bounds(time_bounds, rtime) check_bounds((2, 1024), step) check_bounds((1e-3, 599.0), time) + match signal_type: + case SweepSignalType.SINE: + self.set_sine_wave(channel, amp=amp, offset=offset, phase=phase) + case SweepSignalType.SQUARE: + self.set_square_wave(channel, amp=amp, offset=offset, phase=phase) + case SweepSignalType.RAMP: + self.set_ramp(channel, amp=amp, offset=offset, phase=phase) + self.write( f":SOUR:FREQ:STAR {freq_start}" ) + self.write( f":SOUR:FREQ:STOP {freq_stop}" ) + if marker: + self.write( f":SOUR:MARK ON" ) + self.write( f":SOUR:MARK:FREQ {freq_marker}" ) + else: + self.write( f":SOUR:MARK OFF" ) self.write( f"{command_header}:SPAC {spacing}" ) self.write( f"{command_header}:STEP {step}" ) match trigger_source: @@ -175,17 +196,3 @@ class DG2052( pyvisa.resources.MessageBasedResource ): def trigger_sweep(self, channel: OutputChannel): self.write( f":SOUR{channel.value}:SWE:TRIG:IMM" ) - - # def set_pulse(self, channel: OutputChannel, duty_cycle: float, transition_leading: float, transition_trailing: float, pulse_width: float): - # transition_bounds = (8e-9, 0.625*pulse_width) - # duty_cycle_bounds = (0.001, 99.999) - # pulse_width_bounds = (16e-9, 999.999e3) - # command_header = f":SOUR{channel.value}:PULS" - # check_bounds(duty_cycle_bounds, duty_cycle) - # check_bounds(transition_bounds, transition_leading) - # check_bounds(transition_bounds, transition_trailing) - # check_bounds(pulse_width_bounds, pulse_width) - # self.write( f"{command_header}:WIDT {pulse_width}" ) - # self.write( f"{command_header}:DCYC {duty_cycle}" ) - # self.write( f"{command_header}:TRAN:LEAD {transition_leading}" ) - # self.write( f"{command_header}:TRAN:TRA {transition_trailing}" ) diff --git a/pyproject.toml b/pyproject.toml index 16095ea..c416729 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -19,3 +19,6 @@ dependencies = [ "typing_extensions==4.9.0", "zeroconf==0.131.0" ] + +[tool.setuptools] +packages = ["fn_gen"]