From 81e5046ec109b388b0e0d0cc8c447cefd6d66679 Mon Sep 17 00:00:00 2001 From: Erie Date: Sun, 17 Nov 2024 00:35:40 +0000 Subject: [PATCH 1/6] correct code and documentation in average_of_squares --- __pycache__/squares.cpython-311.pyc | Bin 0 -> 2867 bytes squares.py | 4 ++-- 2 files changed, 2 insertions(+), 2 deletions(-) create mode 100644 __pycache__/squares.cpython-311.pyc diff --git a/__pycache__/squares.cpython-311.pyc b/__pycache__/squares.cpython-311.pyc new file mode 100644 index 0000000000000000000000000000000000000000..928deb7062a60a7956622fea82f459af97c033cd GIT binary patch literal 2867 zcmbVO-ER{|5Z}G?SK>G>NdXZ8tQ-VbIPph5pb!O-5Ri%zs-}GjO|6S><5;op%-xv~ z%TZ00hfq<;?F*r$YE%hI#S2uG`rQA(MwS|#R4G-T`eu|ORXla}KAc>jP<4Gfw>vjG zJM-I_S$`i0v?6GUGw-BTFG7E?iQQb*VCzd5+(9CmMxs~bR`4_y`4u$HQC@T{a7;=$ zl}4ibJ3Q@zw+G&C4pEM}9$|)F&7|iwDiYy3RfIHUJoQ>ZP^j8BnQCeVv z+(9LLvsY`{iD2&B)$t8EznKWAt?wd{djQ%VK{wl{xP+HEsZ-?B_;nhJV9hcox>k_J zY_eJjl{hCN7m!o`GOsZ|Ykm*X4f{8scMG=;)$;TLe4yic`)A`xw#z7j!!WHYM9 zu)Hp03jk#+fo71=B_h%}p^()gM95|>0Rn&%3b<#pOHGXtGF#AKkBmxEf<$I1NzDsV znu>;^*(GCpwoy`^OPU9%f}(UGMW91Zu>a2Ff^CN7s=kNL&C!&WxlZkf)xDN0DuWep zAW91i^p2N3Q5fhxpD{Z()1w_r!*TrJpB5BA(wAD*inKU+V3_G$2J)p$1A zPCet%Tf=o@w%L8M>N^0>=ApxDWA}U387ZxjjHJnSHbqD#Ey;{e7Uwe>Rr8Ri|GCJd%srA;T%5QX8VE&5h@2+u6(1z= zA!DBCX8|yfAR()aTpfsz(-9IMgg!K5Chx0raR|V%a&aGk`!Aq6frISaKV{`6*4@nS ze3(<%Vd-v7UZ9f7u0Sg!6?X9#dv^Kqs`QG1ph|$0QT5Um zmji{>38S_|U|{*PXW4lf?z(Ehi;f*$%w=Ukv%LtIh$pQh{a@ZBz!KXV|7g{C)@ME+ zuk_a1NWG1i9H53bVNUnZ8yb~F05qS?XizAcb-^-2_d_|igF(ltYL!4U^Mkt(RtOl- z!;JVC2&8=n>fBqtyb4?$`wy@Hm-UZU&F~%DxUPbYSryIu`$Vo@2$7@mM?7vj#L9j*1Zq+ i*8=f+AYQ(>>1rvDuO7QOu`*FMevMA#>H^h<>Hh%yMAfJO literal 0 HcmV?d00001 diff --git a/squares.py b/squares.py index d7e454e..0625303 100644 --- a/squares.py +++ b/squares.py @@ -12,7 +12,7 @@ def average_of_squares(list_of_numbers, list_of_weights=None): >>> average_of_squares([1, 2, 4]) 7.0 >>> average_of_squares([2, 4], [1, 0.5]) - 6.0 + 8.0 >>> average_of_squares([1, 2, 4], [1, 0.5]) Traceback (most recent call last): AssertionError: weights and numbers must have same length @@ -29,7 +29,7 @@ def average_of_squares(list_of_numbers, list_of_weights=None): for number, weight in zip(list_of_numbers, effective_weights) ] - return sum(squares) + return sum(squares) / sum(effective_weights) def convert_numbers(list_of_strings): From c738095da6b55e89417d3ed779594373289153a3 Mon Sep 17 00:00:00 2001 From: Erie Date: Sun, 17 Nov 2024 00:41:07 +0000 Subject: [PATCH 2/6] correct documentation of convert_numbers --- __pycache__/squares.cpython-311.pyc | Bin 2867 -> 2887 bytes squares.py | 2 +- 2 files changed, 1 insertion(+), 1 deletion(-) diff --git a/__pycache__/squares.cpython-311.pyc b/__pycache__/squares.cpython-311.pyc index 928deb7062a60a7956622fea82f459af97c033cd..f03cd4922fda4a4c853de1d197ae6140ead35afc 100644 GIT binary patch delta 65 zcmdlic3g~iIWI340}%9ETc)>fuwpomKIWI340}vQlS*90n>> convert_numbers(["4", " 8 ", "15 16", " 23 42 "]) - [4, 8, 15, 16] + [4.0, 8.0, 15.0, 16.0, 23.0, 42.0] """ all_numbers = [] From 6f904cc157a19cb4151949558c3ad8104afb319d Mon Sep 17 00:00:00 2001 From: Erie Date: Sun, 17 Nov 2024 01:19:32 +0000 Subject: [PATCH 3/6] generate documentation with sphinx --- .DS_Store | Bin 0 -> 6148 bytes __pycache__/squares.cpython-310.pyc | Bin 0 -> 2026 bytes docs/Makefile | 20 + docs/_build/html/.buildinfo | 4 + .../content/average-squares-docs.doctree | Bin 0 -> 8981 bytes docs/_build/html/.doctrees/environment.pickle | Bin 0 -> 15980 bytes docs/_build/html/.doctrees/index.doctree | Bin 0 -> 5160 bytes .../content/average-squares-docs.rst.txt | 6 + docs/_build/html/_sources/index.rst.txt | 21 + docs/_build/html/_static/alabaster.css | 708 ++++++++++++++ docs/_build/html/_static/basic.css | 914 ++++++++++++++++++ docs/_build/html/_static/custom.css | 1 + docs/_build/html/_static/doctools.js | 149 +++ .../html/_static/documentation_options.js | 13 + docs/_build/html/_static/file.png | Bin 0 -> 286 bytes docs/_build/html/_static/language_data.js | 192 ++++ docs/_build/html/_static/minus.png | Bin 0 -> 90 bytes docs/_build/html/_static/plus.png | Bin 0 -> 90 bytes docs/_build/html/_static/pygments.css | 84 ++ docs/_build/html/_static/searchtools.js | 632 ++++++++++++ docs/_build/html/_static/sphinx_highlight.js | 154 +++ .../html/content/average-squares-docs.html | 144 +++ docs/_build/html/genindex.html | 149 +++ docs/_build/html/index.html | 123 +++ docs/_build/html/objects.inv | 7 + docs/_build/html/py-modindex.html | 121 +++ docs/_build/html/search.html | 120 +++ docs/_build/html/searchindex.js | 1 + docs/conf.py | 36 + docs/content/average-squares-docs.rst | 6 + docs/index.rst | 21 + docs/make.bat | 35 + 32 files changed, 3661 insertions(+) create mode 100644 .DS_Store create mode 100644 __pycache__/squares.cpython-310.pyc create mode 100644 docs/Makefile create mode 100644 docs/_build/html/.buildinfo create mode 100644 docs/_build/html/.doctrees/content/average-squares-docs.doctree create mode 100644 docs/_build/html/.doctrees/environment.pickle create mode 100644 docs/_build/html/.doctrees/index.doctree create mode 100644 docs/_build/html/_sources/content/average-squares-docs.rst.txt create mode 100644 docs/_build/html/_sources/index.rst.txt create mode 100644 docs/_build/html/_static/alabaster.css create mode 100644 docs/_build/html/_static/basic.css create mode 100644 docs/_build/html/_static/custom.css create mode 100644 docs/_build/html/_static/doctools.js create mode 100644 docs/_build/html/_static/documentation_options.js create mode 100644 docs/_build/html/_static/file.png create mode 100644 docs/_build/html/_static/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/content/average-squares-docs.html create mode 100644 docs/_build/html/genindex.html create mode 100644 docs/_build/html/index.html create mode 100644 docs/_build/html/objects.inv create mode 100644 docs/_build/html/py-modindex.html create mode 100644 docs/_build/html/search.html create mode 100644 docs/_build/html/searchindex.js create mode 100644 docs/conf.py create mode 100644 docs/content/average-squares-docs.rst create mode 100644 docs/index.rst create mode 100644 docs/make.bat diff --git a/.DS_Store b/.DS_Store new file mode 100644 index 0000000000000000000000000000000000000000..a18a306984cdabc30b277da80d6173cc03b9235f GIT binary patch literal 6148 zcmeHKJ5B>Z41II3&yKQib z2k!l2|IPWXYd5=Y!w9A4l)8K|p$AmhqGLusj+5svaYyKJhdnFblb0S#U1^+yC+0kU zs;%`?l7VC(8At|_fuCW3cecuG?wB?iNCuLDcLwx)C{)EdaB#GvgT`6_V#Q$-`ubSb zoDx_E4vw6mh^G=gRiecZPv>}vxH@of^mIrx9}+9SH7{bTvwpE~NbQ(58At}k3~295 zS?K+L#=p#DlW!qul7VF4zcL`z`eMD}*TvoX?K}0ZE!0b@ipCAQHrRdn3aiTMyPLeeAyzresNG!iva literal 0 HcmV?d00001 diff --git a/__pycache__/squares.cpython-310.pyc b/__pycache__/squares.cpython-310.pyc new file mode 100644 index 0000000000000000000000000000000000000000..a9ceddd659820213d87512e7be881f221bf50553 GIT binary patch literal 2026 zcma)7O>g8h7`B~ECY`12Zntn?k+8ZFYG9a|PN!vAsu9rc1&M+vNGPR>(!`UAnvZGh zbho4Fg{j05@ej7#_!%7d6S;EY%mE1rmDl;0mTtwaBfpLvzxMk+ejX>DpKl;2KYsL~ z_d^|_-(}}|QK0iNRQ@d(7n#VNbBU{*V-vfoTRTT4VT!9Ak>p(ux%Hp1sY0tmTVsT& zQ*3I`)}XC3%rsV?5>sb$OrK(mT)dZ8qcMJOI}S&wu!SE-G#=2W%=d@DgGW$@EM8fuHu#7 zmeCn0auIlfCS*!>z~f92WTJpSff4)w?IA<6f5iyVub4=ah>9V*HA-v%LaBDh$gjzpqxMA*P683q`dCsD^sx5B%eVy12JG7l6x*EoSVZt291^@u80-Fn?NaGXESt5z@ zBuV1rafunEAGtJ2!$X#E8m8bs1oBXBhl~a+^2D%_r?NXXW`MoS;}1A+pz$3!16obU1TO>ameEh-nCzinP$H>nC>d#WGOY+M(~9l$Pr3Pfv;7UE z#M^_@u)V|hk%&j_?Jqw6veR8(Z1{kWT-Bj7JBfA&oRHwaf84 zmE+avwzh&8(Byr1sT?6V1>nh)u|LWbo`!~ME>_Gc;k+6sku&eH!GJl!KVcR7%z7Ev zRbGh(@nlOc#vuXZ%V6|-OPFBwQX>mQ!@8pVbGMekVm&>v0D)}guBOqUO{M&XM!F3|&l}5Qp{K(_fk3?LNr%8P; zisd+cI`jqOBcSCgYsxA1uuAAw_g8u=O}auKQQ53*(6!CH-(8pYLa$3#O4aQ5TAd~Z z?KJ7yMs7Ey?XFAP>$W-v1%LkojilF%juO$FjvBxNuw0ZhEJ%p6n#^`&kVKL=tBLrC zMK?|>fu8{CK>bs$yo|;VZ{%|ugwPlB@18- zl4!J%n|038`~Bep6W>$$c2fbju2D zKe8-P3SP@_H^V(cNnV$s%#49|jYd|tEH`#6E2r?xJAxa?vdqPj5oLPZTqwj;^|N|8 zA*+`v%QX1i!QUdQjew2fTKw{G3U%pQVeF;>>&r`uzX3)?4Ml%jU(zu=M8^&C8d3lH E7xAG6h5!Hn literal 0 HcmV?d00001 diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..d4bb2cb --- /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 = . +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/html/.buildinfo b/docs/_build/html/.buildinfo new file mode 100644 index 0000000..dde2178 --- /dev/null +++ b/docs/_build/html/.buildinfo @@ -0,0 +1,4 @@ +# Sphinx build info version 1 +# This file records the configuration used when building these files. When it is not found, a full rebuild will be done. +config: 04ae54f27485e740a0c7fac960033234 +tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/docs/_build/html/.doctrees/content/average-squares-docs.doctree b/docs/_build/html/.doctrees/content/average-squares-docs.doctree new file mode 100644 index 0000000000000000000000000000000000000000..9865e3f8558c98227b423c79588ae87c7e654ae8 GIT binary patch literal 8981 zcmds7+ix6K8MhPf+Pm>3cGJ+3I!sfAu8F;NE-k4^Q%YJSWYwjm@Icy5XLru}%y@QY zI~QM6N<*bqu{cGA4wr`(@xTi&2&oVJ1E5O$0jLO``p7d6fW+nZoik@0<0OJ7bKq83`) zQILdfmWmNTw7KKiA@kGcQZY^7vExO}Z2x$~+OZS(`F396RX+Y)+Tb-&iJjPErB7o1 z(JdBQ8_f8|i-{Go$apL}-jYaYBle9w!*=LG9|rzfs%~8E0T)Q%v!Z6^1o5Myn$fW? z#yrPo>3Y(#MBR$x&}k(x=qGxQI(9^~jki53im-_1if?t*(}bP$ikFtv-V9lXU=lGN zTO0H#iaiX10;>uY{?YN~Jk@dwVj? z0dcQv< zvzVfTr1i>o)@K5>ovybU^(=B{6W9Xd++r!o(}5gWX0^|MjLO{{W*wREs5If4WXd2% z=Jwk{&hVtz?^D608;5aeg1DquG(pD>bBDjgzeB9}Zovxva(>r2c~`Q~E{j=6(k_ef ztQP;F`jD%GQnnmh8Pm)FCZ!i6O0cA#<{-oN-*Hk5trx8N`N6Cbqkd|YwT5`|HhA(g z1dIc1S~Kq_0Q?bz`%~=;#0gDL*)TFjypu!acg>)*H4Lp6H2n5p8u+jFrQltub+b~E z#K@qB02~Klnf;>=>!a~h9QNM9hl$Z(m|?#MALzK6s5-ukwV{-`d)ZdH1R1B$!5xPoI6Rc5Zj zc!fpC`>RKobIMUfe)1|*P*I+t&fh39IPUPhKo2YJ`I1)Pr2jS z#lXaZMeHlPMy9ljhUIw~Ck!O121DZKdAm9577Zk#V5SopZOb=W%xH7V-(YsVwJUi% z;7NdFL+0x_Uq7YO3Sr!RyTWkqq8+E#j`lO`nARz+WXJV_n0S20>h?UgsvSnLP~77S zw{;Js=8_@bqQY^+X3GoOnY-W}};6FNaSsB7}0oWBx|WHE;i~X;kV0*{?$O(LgX4Rn-OHpd`)SQ|(kh%gGJB=0KvF8d#6-5diglD?6qD*D1K{(y4vIQTN`_>%&Fu7M z8Fv|BhQzJNTPfeo=T(wl+(yNjBfVWDyPd>WwfR7hv4gJV_^Epxn8Y{&QM}t@srxLw z$~>|B?gvY%=-d@g&NDX8b^}X*j|}=S3`zQ530Y z`n+`ZR8waJ{%>^_|F$@b^H6igx@I}3y84VRNe18#Ev-!Lu(SuW^@1=4@Z`0VDup9m zCAs;Iq6W$e+G3&bd9RT0WuIZcg0;c7_;#PLb&85o$9*Z^E3SW>)y@E=y3~0kr)*{j zLRB_H>jj-Z$nUy8o!{qTUpi68l<0KdAT+A-`eAV$9a1wwI%KyWw z?g(JrH|b}TetxH4Ur*hmcowq*(l7GRTs#ok4nS2l>Q?cng{2LvNUpA2QwD7miDt%c z!|~%lhrC4tO^rZyowm7y;7$#IJZJi7ND8_BA-lD9QwP_I2#;E(;yR^EgIaO@%%wAn#u?+XLI0e8z&QV)e7|tf zz@JMOj5A1|u3u`dEE-6n7LD@{$lnL)_rgW`y>y|uf{uyuEuZKaN&!IZUqRMjQsF+1 z#lBK}AfFiKP_-QMsULm5KbLTylqgGCgcdQf2+d{pDFEGK_K=&KR@}n&KRkhOU%)}` z#1Z^h^i-p#R{qq+)1GU~UnYM$@^?f2a{24fFPX$ppf4`c;8(tbiG_}NK^`piG zOy@^ApzfC%{eYHkh-X%_}9IAk#`#C;%W+KlHY)UmnEr~lzmzQKy=AQnK zCZlS~L@jQ63`3JDT^0QrF{3zN!cvh~FsvH*GJwK;1a=~(72e_wdiOp39|ksy<0Ka7 zUc|v7Pd2lsJTwXt4Aa1I8_n$_7}1G4P$34PZQ88IFe~!gH2hf?Rk+&@dQaepV{3&# zPifjp;=nAH#1RMTHf1N>o|&s87%LYLUs>o|9wD5OD^l4>`o&T&Vu>A?Xu1RHINRw3 z5i`p>rIxhO&T}G%`jEh7+D>G(JR&5!<+wH#nB63ZiBKCTn}^n9U}nehKpduAC+P`? zWQ8zfL)cJD!2qo7{B>!Z5E9QaU48jdq)SUz=F91k0X6ReM0%_L3dP`?lE`guZVW&NSo>mI(%{$VTKjXUK4=z>@oYv<99!hIlkWpCiJWFeq8lOF0mnh47= zZ{`N}pglp`@jK9g%rDH5qll8$0GQJy-Sq-X86!<-H&dt#W=l3Kco#R|jG@0O?rZ~U z(_|=HJrnaJ^1G1yO);BIpP{Q>NBOipag_O6H0c!+%A3G^p^2zm9oR-}#^|6icqi!1 zEG`Ajis5bpA6kaF?#ro|>szIMs$2%PPX1CQmx{45z{hD(JvZDriiI;|=tcRzo`@R3 z$SRj6&Jt?ReHCB`g7?x2Z9%nrg?i`eg1N6B9xYz!Yc$9?Z^enwI!5z=pL1U)T=U{% z9@q9wJ)h;wT|*3)9W_}k$dbbSC#_L_lZdIZT1rMuwH-ClB~wr<|;G zL3A9ymaV@9p}J3i>uaOYYw6Rlcl71qIiNTZRGbcmT&JVm2;M=j4$HTwan3!K^gO2x zH)1$&Ck{w3lvWs|NUO#f-CH`7mo&>Cw&#NzZ|hwj+<2#1%z4~*Nns9bDhzkmPr1Lr zj>EDhsR)*+WPy8BjLDXg82j4#SD&O{s{VV4%w4npnt?I_y8COo$^k`$CFb&Yqq!)B fdMsa-rhd%v+g@UmYuO+xuiF$7v*@8}%;tXqTWrQi literal 0 HcmV?d00001 diff --git a/docs/_build/html/.doctrees/environment.pickle b/docs/_build/html/.doctrees/environment.pickle new file mode 100644 index 0000000000000000000000000000000000000000..1e925b8dcf26cc65c6f24b271f71fee90a4b3cae GIT binary patch literal 15980 zcmb_jd2}7uS+^u>dD<-5@}5Q68aauck|=4@q)F|>Nl0YNZe+JKi8Gz|-aOqI&6|0i z#g?2pOPi!t&OIlAObGi{D6|v`g)Tq~r9e}lP@pC3TcJ?kz&Y%D;rD&_-kFhP#j)G> z$Gi7_cmM9U-#brqzi8jFfq!yy+!k)ISapIEZWIPBCrC0ma%bxLjk`;r7qUH1W~Z|W z*=4ue*{tkug!LqHoQ4}^a!ikrCazz#+IAv*x0cC1Yc7cnqm;dXjvZ5(>^>ShQJl%H z=29z@z5AVbAqm@PdDo$Xhp)eJdODMv>=RC8&pTFpJhdYSjW=Q{Bt2G*7KO4%T7D)g zRlS5bOR@)0A4hdsji^kBelZ{h#gG^lo5YB!t%pI=ozLWuUaKkh+@&h=4R*&)lJXXv z#l#6>Hw@zJSXLlvF{#>V5@PnumVLe*%%@myCOe%VlLLNOw|&RLO1M|AD#vKLDGt-9 z?pRJx4;yZPwN%oiIeE)uOzRp9fXvuZs{?|2+fnE_bsR?ToWVp7<`p3jUb#DRo$-4x zbtXr3L#rOPmm+swpv$HkufOr8>&8p1Dn+fhUiJdVw6RQX!1$5lJ9dm6bX{M)0f&UW z*-M$2mKDxf%~pa1?Ew1H$g#|Zt)}Zcf!#vCZI4D_n4GRYYU)lu3f!H}l9fbu5c_t*h+UQ!mC6?OGLJ)#t-5c=F;0J3_P6XfaUzTGExX;I;VjZA zDqO~Cv*|8^Fy+Q-6cgp5cM_%b1WRqu)LAS?oW;7IHXNc%jKs$|Ax358h)7$txY_`% zR;v5wK(1lrWR4thgEbvw=QY>h5C{|JXxenyT^ zT`O#)pa((}!8Rvh-3n`TvLJ*6$4Jmi*FvpW0Ap%EqW(tMvRxe5#pu(rn!tAuCXN+3 zO$T#=tm3v^cYv=!?x-k*@HgCEnkTLXZ6!;*=FI|B;uEFhhY2ds8v{WV)nQwm67V~m zIIT8L&54=8i6i>097g1A3RW$08(@f8Ikez7ZR?~R1t51?%V?ao+kCz`5aVp-6>Er< zEVUUY+kiPfZ4h>=Maacoan>|3j@okCt{={07A}EsRB1EgheQJi!D{+8CO!is0Bd%% z1S(Q!>})TASQO8d_#7J@Y}r8@3>{l(aQ9}uZvEn_P|IFNY| zC@Ok_v_%qUS#D7|D|YJ0Sq-NRkvP*KhcvtyMlCyG>Dr4ngmUb0PUXh0qSIHrhf})8 zov$*eJF#mxP1$#ZQU>)yt~ir5NSp=qKj6j*&`vd}ytrjAx-Co&SrgdA9G33}_;Z4J zEM``2!U}|i1=YZ6;8r>;206!pcF-FyaaInPcC@uKMKN|D#yhH*H}PW&;>B$)Q9YIF zAj~L<>8Mi3e+$TklEGLpjwCsrf{vLrN=3`oXy`h=ADbL2S7~mJ8DSM8a!A@v$WG6O zkT@l*yJl5-zs0SFzX{R;X z5=+c`_x5Sc+0SrrJBh%JQ~)U#FssBon;7giuy42NI*{PKX|NE4C$W$Lu8ZqDj(AD- zaXEDx847BSdWhMxJ-RfHItQg;ZV0YmNzB?t&C?Ev@*$lWHcaZ$szavcAhk*(6?5;enJmB(%GAWX3=@$f5xD6i&i4 zX{V&ejX~GV1|7rzj}N^CoeU)lNlb`ThoQ6piCMGP&g!@sQLn}bHPDkfCk-!=q?*F4 zz7A~!c9=E@B^$J%8Bn8I?E%E^kX}R6i}WHvEu=D7Aq1f@6T}DfE?D5h#DFx!6q?{~ zvWVkQhIpg~9@w4i{!HE`lB6BqIyF^q1XV9?IKF!#ss>In6|`GZy6xWSDJQ;p3fP=% zwfxCCtptt1lV-5ePKOOliwl?l?YDT3Xj( z#nZ4X49FO&`pk$942Udv*2$m)14~IhFU!rQOb&tePtM3)Ike!r#Et-EfxO*RGkY8B zm(2Q|_Z&TNV0?Dp!Mn%bboar1_Z`@~Z~y)W?w*^w1Dss+QVs`8?*t`Sv&M~CBO0RX#Yw*nH+say-@E?C}A zTLHGbQvu<&`OXQ)C!>atL;lRH98;BRrHX==WPfK6g1bv#5=^i(*kV;+cqMGN62EOz zppqcVwbrPrVsl8FxI_VcwJ=-&5JUyv#}A_@JQ;%=^qh>CvWnKYP;e$?;9`V$2bvk& zQCNJt3!qVu2(^Ll`toy`veGo&6*>{+VdKAI{%bhhsKaH7~HP;0xY}tFw?URpPe(gKp;Bsx? zoCH>&nB~SafbS!>Fqr(xT#c}1F=J^1euZY~UxfV!Gcid>y=|&nZo`5j%r+E;2Kj9! zy96SB6?mj>DXV0`SpqRNsO^O8g<$|6f>z79u!+@y*p00*cT~35+ihiPtn~{=xo-9D#t3@0{ar>C z=bCSX8bL*-^H^oL06Q2CT>)c)pgP?JfT&0;FwkY~ zCB%6Gi!HkV(I20@h6cOFI+Cy~uhfmswSmiZJFOmxcfeaP*brv(wYQBefj@jlIDQ*y zENH;4f`WrUFTf4w1Ua|toOV0GWC{w{QB><*#!ZqPh$Iac)!I59DIg0q?O>PYh@2Lj zK@Hztv{i8cBf6l3imH|yKodr-!j;`tRB}I9TFNxpG?m8DRLu>hgiE2yOqQk~-Vyxp1u z#ZG3ycGF6Yk_QPePRm_{crIF)_*cn5+iiMd9wKY_VZ{jWA53+NtW38>vYo{aubb9J zAs+;x0hN`ar@Yd1%{zNMd)Vsil~f6P-ZVS49Weiebleh2Py*I<*OLt+-Bh zA?%(#lZi=D^_Dv}Y(REOTrV~wy+NlpifL1IlepPrUtd7qFl&HUh$~I@D)Bm#y+ypy zWN%%Tz1ohXS#Mi56>k!^>#XdfST09fbC|e8yxFvz5PMAaPH~sX-Xrcc+57V4+<(Tv zX7b#DJaFMNr^PcS`@ES(hiu5}<50c0ju-q*c@#^$ zfQ^2$c!ASQyhy2zGbL_<03&)3NJXhY?{xnlsti-%pxjp#S29$GrP3PQUhs@*tiXj6 z4(g_9^|i+r&#|6W_ka4bJhN!55qvIG5p8HPcV^vSo|cX zKP5gwsR=(ZF6B;rl{1cumT`y@b{dp($&K^a16#j@{&RH^A5|>yF_nB=CEqK)j~DUN z;%7MhS@8)@e@^^7r=L>IeqotQpBBH!=`V?2=JYdXIC)tmpB2Bt#UD|{UsZj6O_e^U zl3y3U!EHV-raAphHU4j@fgnG7~1(y@n5F?zs3LPtQ^!1Z2*%PN7~nJ z;9deIJEAb4kWH%AkON!U;&w#G)wN%h8kQ~rOLu?bt4U@vUjC0ImbZZzp@SF!1ACpw zu)s1?5G}(SYQQn#23=^NI&MVn48yvS^Lp^drCwxI+dhI<47{I81Ew@cr6FAs|0}-A zeMbm7YT9h3(iUBk!}*?-opPE{;f+zFt)|O1Ds4BV9aP$BO1r4E+mtS%(#5892{JPs zyoO6DdkJU9DcjB2%aB#Oy&O633j8trDrEL>?sdrJt}8>X21H?E!sKLyTu&8Ig=d5_ z>&-8%2TGg{w@Fm(nGSte-X1f6ca6!(Eiud{7~mAE&jYxMFWFOMA9gi~LO5SZ*dc~xS9TxJ>$Ke@^2^sZb9Dgj`v2YxV2P!Te;LT9Qfl}>3%FmVnhbVuz1b7SbdH)AcP#c`fb4SVzjuP1H^sVK> z+se(pu~Z|s7H))gnzU+`mAnSlnfG=c;c=WQ3J;>-Jw$&R@G#|%l>m<*KdWoYejEHO zoP7gV;?UxnDktfp-;89HI(qLY7i<)kO|x35rtB`p2nDL>0IW~7INW^a-Xy#BFeCE1 zO+}ruFyx@&m2ZG2WR@j&7wwD-2A`B}&=AMSH(K&Q^H%E8_m~;Ut7GL}gZ?z`9LhIK zfO+K2M&$@RUG~XJRuf&1GY|)Z3v%P*7O7&XRC|i@kCp)M zr2Od;;4#WSUIIKp`6o+&cOjq8@a}TqDHIH^q-jkKspvajgh3D?q`74UL=qIdssiD$zS-q>PsQ`I(wgnJBiy;dS#$)tBk)c z_R2n-uzJk#9D-ryJ<3Je@t)GJmnJniOrmw1JugQ%tbiy1IabW>rzw<1aS47ZRXH5S z?&4t-@m31aGkWF14_cna(gi}^4uW7> zHQeWEOlswQftunx@<&0mv=NO)6$*{3^=zg~?pO^Jc!31Z7m?=@*- zJ{sPT%~bMtV+O43Y_#9GYOEr#M$6c;s+R7DvYAe~broC%zOtE(Yv!k?Lg=u1S#i=J zaE}@%o7tPnF&)sNpayWS?okn<+q?pfdp^7dS(bgk1>Hka;9&ycFS->%v{k=ck)4RC z$sxWeM=;S=kH9ukKnPb26rVv@m)_{WZvsx2<<>e{E#PGWBFYwmzVvbiL5(wVu#I;$ zBtM%S6@&JEzWsDRO2KeIiK8i^>)daohK$pSGsS}eaV1_&(OVSD zJVr@nAEHVe?V+P&MtQdPlOO7pqgVGZ13lZj>lH4g^d^ih&~Ob*uesy^uA6*p8f&JK z4hi9YEg|0Kw;RlkS@P>H=>!am4^z*t>{_KSEdO zK*+`Wz)HCM8#h+K{uO@l(;2-xl|AYuT;^Sh&T-9_{iQ1mVzw@q?A6e;0=#=F@{cSN<3bIyxNI(8M27BU5*5czY2-mYSs#L zmV9`%R__`#@ovE%*6Ce~lqhHtDY{RoYtK?=*Qtu5&^(s=??}vDsMR9`y?Yw)n zKpH>AD<;w}hC&r)2WlzkPdz)x&tugt_y{WWFu}q_Kx>_56L_<#UI#a)dBQ+(uz`p?mZlX68uR8V*qVv~y?C<9t zosZ;ut;fD2KlW9dSbOI0JO4$z#xsBKd5^r#nLFpN8}7s0ino+lxqu-G%A2{+jnFEL zo?K6^txM1o7a-SOtIqv9EbRP<_w1BM{?@rv!&fd8dxiA)vcluKD4at*%oAnG72;eQ zBHAorn_=Td(8X)FG!zN(E_>lX^G68B;6=Z>7yAr-{-BLf^ZLpg#mx8$29FT*qv1|i zV77X)D=T*?Z#BLZPekVZum&T)N4O1`%E%4rv2sA4dc6V@AFqY`mFW`(K0V{SBbCF{ru3!=CO3od zVp5$7S($P~6C-ZK_yZXN@({3WnG*1^4U-1N8zMZKp%1pugzDhka8tN6LqrQ`!afRn zE~Dn?S3vQR8GWt6o(b9b9d!&gAqV(|I$mnk=+V)dphVR&RXua6O>Ur)Q3nq=c5yiw z%=I8HR9d*?8TN*TRXTK#cl6h>`mWoe#*nf)`>s)=DZYK76P@rL!ssBa zUbV6nRJ4&pWu-<#_~gaHi&G|X)t!*F%%d)+Ic?GBQbjk=UyiwTf^Kr)5P#%$H`L1# zbeB2=?=? z;2?jhca{~?&qaRqQ*g(RJ&wHCA$zMli{(i2^(9fO*s&sg*$);z)^x38?A*;U92owly5YvFDT z3XF!^y|RXf!|T($e#gpsifR^9uIkJbQ?e2eP+YNA=q2@aCgxpRl`j^0lGHYYd|Ipi EKXm`LyZ`_I literal 0 HcmV?d00001 diff --git a/docs/_build/html/.doctrees/index.doctree b/docs/_build/html/.doctrees/index.doctree new file mode 100644 index 0000000000000000000000000000000000000000..09a6c79e2473e1622bce706a5f6c682c872a899e GIT binary patch literal 5160 zcmds5-Hseb72dTyyF0T#-gRt;$hK%C60ebWX6+;jS_M$#5CKaT6ax|xR&Pyr%~Y{H zUG4hWp9>VY2zaHsOLK*I1rXvQQr-Z8cml3?hDf>PtE%pv-my0r5^h*&rRh_rPgR}s zo$s8}zwG?>*3~)xXD_RQ@%*??(li$-Ri#}@MPep2*X4)honMu|C^v0ak|QOIOlWE6 zpph`1rIP05BP^~tea$n~uM8|EVshqv*0Fzk_}CChRa6@%nu|P|5T&V%Mm(c;qeN1o zX&Mbrdf`x8j}1=_lqOO~P=09gXipqQ_uh!Mw|8E@xAXcN(f#fFul0LB6(&kZ9+8w3 zI?{|QZ!*F`ii~QSokUthC%8eB@dKWZ??ywTBd#OGgvru~=qRH&OD_?*COn4?8c88^ zw68^?C8hgO$|X%SKcxMVEj}t)*IxP&J$7FDKfB!rrHi^i%CY5f)KwuIhllCOQ|WQ4?~h1NILR5-Q!8NqYC1nv{V2QR36gO*hNjo z?v0Z5*mZW%cH)^z96Oj5pL^bTS#dP1S)G#o)mY-u>bB{a0TdkV7iTn8qq# zZ2${u!1I(I_odRMy_E5smb)D@MDP}si>AmMl(P<7aDm;#Vn=hG(bkf^_Dlc=By60w z8a%m)3*BR{u#4>W9=o$=hJ?Kc7qXWCq8s?Xh5s+(|0|D5!(L_ssNW6hY?IyDUG&FY z9-0hLjx&y%)QQNw*>1l_wUGhON0g75OR&mMkr+h;389c(qv()ihN=eJ zT|}RZB`H|T9Q%$({>Fb{cIt}nKff!!$8LKUEWsu3{5!wB-BNzb?E$}iI}jKM=o=42 z4tVI+jTHc$k5$BTkV9@JLjdb;#K*aC^5}@cnI5VAUWoHOX!4&s zvwwZh@yjBrdH_~*CMG!U|5T+mEplymz2zN8Pe zGzm~kQ^&9S`;j^UDIfQvhm<;E?meXwy~(sL)XrdVbad3OiU+d4FXVVY^Fb&x1EatW z18`2WfyM?ELohwbzPTUwYT5|}Y9wToQj`RgHy^i6wqaj9=kVn;Chxan;@Bnwm?X(s z$z-oS>#{XC)@S|DGJe`N{@G;m8^rE?cz(lfJmtog#o6O_LDv-Q50;*Cjs4mG((%u8 z@!vn+#qA|uN$k@;vg0|oN!oV3kRF@8SyR$$p zNnK8!xmJ~!#s%yTuG;+3_L^9y? zd6Jowx@Oe1D(oM`E=|aBN(;@(-3w@S&|SKY!FECaj8IhUKYUU_4FH5}(@D z%1|R%3dM!OzjL;$?!bk@^j`p0?~_D|=uzgIN64yXNfma*;S%0F92sMH0O zfWS;Q@t4}!!4A5QX^`x-mJ@u-?@6zPqgvr?+YW_Rzw$Nga4{ri-LFiym<>B*0OD zkz*9PL1~x65zv<92T5+Xd3Aug*z|U9wS-v z*s&Y*n8S;jXrpSSj_ss$XvWxX?TE-6UW5ilvk4?!ge;-%O746-htFbE36VkzX<_te z>+4&JYxt0C!8!lV1*=Z&~ShE2X_Pvod4i=U<(lo3m@d?(_`x z+c(cH%)D&Z-5r2E#o(gMPa~@t$;Zac54aDelM6^@`vPV@A=4NnKru+>~;4G zn_$v%e23ULYbip$47zF_cjxVf%Qqk=9|MRPpKx8iyMEiQ6|{((vf?hY;v_?Yv%A!= zU#hDw#HwGMXeM&std;hf)AR>`W{hzL;n99rq{Y_D+poc&YjTv#n0Jz?`B!T5NM7O~ zdq8EMQ$6x~fDi_*+e7+xH5np{Qb+Jh_7*TXiJRnXE)a)#_0+D1PBdm1q%t>5xtUTp z=&z^=zEZ@G4YFFnQ7`!C@EB(zA)%(&TM5Hll_2mT-{58MLcD!o3KRtQHN{tmiUv?l zAmRB47^ryRiX#eThBIn>;;@?u5|Ysky9Xs8gSjR}2A|*rjG{L=wbv489mI5kwl>Cx zAIH1?)Em`I46J6Oz-g!UBFzs=)D627*aYbdB%;Rp?;&yMc>HX?fkOdV8gvWPpprT^ zw^z>eat>Gw(F$&q`)!V==|v^`}m1rFS*~J zpqcoH{mIzXcI3RR)r2Gd?l7<)BrZW~y>RHZB`_ +documentation for details. + + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + content/average-squares-docs + 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..d9846da --- /dev/null +++ b/docs/_build/html/_static/basic.css @@ -0,0 +1,914 @@ +/* + * Sphinx stylesheet -- basic theme. + */ + +/* -- main layout ----------------------------------------------------------- */ + +div.clearer { + clear: both; +} + +div.section::after { + display: block; + content: ''; + clear: left; +} + +/* -- relbar ---------------------------------------------------------------- */ + +div.related { + width: 100%; + font-size: 90%; +} + +div.related h3 { + display: none; +} + +div.related ul { + margin: 0; + padding: 0 0 0 10px; + list-style: none; +} + +div.related li { + display: inline; +} + +div.related li.right { + float: right; + margin-right: 5px; +} + +/* -- sidebar --------------------------------------------------------------- */ + +div.sphinxsidebarwrapper { + padding: 10px 5px 0 10px; +} + +div.sphinxsidebar { + float: left; + width: 230px; + margin-left: -100%; + font-size: 90%; + word-wrap: break-word; + overflow-wrap : break-word; +} + +div.sphinxsidebar ul { + list-style: none; +} + +div.sphinxsidebar ul ul, +div.sphinxsidebar ul.want-points { + margin-left: 20px; + list-style: square; +} + +div.sphinxsidebar ul ul { + margin-top: 0; + margin-bottom: 0; +} + +div.sphinxsidebar form { + margin-top: 10px; +} + +div.sphinxsidebar input { + border: 1px solid #98dbcc; + font-family: sans-serif; + font-size: 1em; +} + +div.sphinxsidebar #searchbox form.search { + overflow: hidden; +} + +div.sphinxsidebar #searchbox input[type="text"] { + float: left; + width: 80%; + padding: 0.25em; + box-sizing: border-box; +} + +div.sphinxsidebar #searchbox input[type="submit"] { + float: left; + width: 20%; + border-left: none; + padding: 0.25em; + box-sizing: border-box; +} + + +img { + border: 0; + max-width: 100%; +} + +/* -- search page ----------------------------------------------------------- */ + +ul.search { + margin-top: 10px; +} + +ul.search li { + padding: 5px 0; +} + +ul.search li a { + font-weight: bold; +} + +ul.search li p.context { + color: #888; + margin: 2px 0 0 30px; + text-align: left; +} + +ul.keywordmatches li.goodmatch a { + font-weight: bold; +} + +/* -- index page ------------------------------------------------------------ */ + +table.contentstable { + width: 90%; + margin-left: auto; + margin-right: auto; +} + +table.contentstable p.biglink { + line-height: 150%; +} + +a.biglink { + font-size: 1.3em; +} + +span.linkdescr { + font-style: italic; + padding-top: 5px; + font-size: 90%; +} + +/* -- general index --------------------------------------------------------- */ + +table.indextable { + width: 100%; +} + +table.indextable td { + text-align: left; + vertical-align: top; +} + +table.indextable ul { + margin-top: 0; + margin-bottom: 0; + list-style-type: none; +} + +table.indextable > tbody > tr > td > ul { + padding-left: 0em; +} + +table.indextable tr.pcap { + height: 10px; +} + +table.indextable tr.cap { + margin-top: 10px; + background-color: #f2f2f2; +} + +img.toggler { + margin-right: 3px; + margin-top: 3px; + cursor: pointer; +} + +div.modindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +div.genindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +/* -- domain module index --------------------------------------------------- */ + +table.modindextable td { + padding: 2px; + border-collapse: collapse; +} + +/* -- general body styles --------------------------------------------------- */ + +div.body { + min-width: inherit; + max-width: 800px; +} + +div.body p, div.body dd, div.body li, div.body blockquote { + -moz-hyphens: auto; + -ms-hyphens: auto; + -webkit-hyphens: auto; + hyphens: auto; +} + +a.headerlink { + visibility: hidden; +} + +a:visited { + color: #551A8B; +} + +h1:hover > a.headerlink, +h2:hover > a.headerlink, +h3:hover > a.headerlink, +h4:hover > a.headerlink, +h5:hover > a.headerlink, +h6:hover > a.headerlink, +dt:hover > a.headerlink, +caption:hover > a.headerlink, +p.caption:hover > a.headerlink, +div.code-block-caption:hover > a.headerlink { + visibility: visible; +} + +div.body p.caption { + text-align: inherit; +} + +div.body td { + text-align: left; +} + +.first { + margin-top: 0 !important; +} + +p.rubric { + margin-top: 30px; + font-weight: bold; +} + +img.align-left, figure.align-left, .figure.align-left, object.align-left { + clear: left; + float: left; + margin-right: 1em; +} + +img.align-right, figure.align-right, .figure.align-right, object.align-right { + clear: right; + float: right; + margin-left: 1em; +} + +img.align-center, figure.align-center, .figure.align-center, object.align-center { + display: block; + margin-left: auto; + margin-right: auto; +} + +img.align-default, figure.align-default, .figure.align-default { + display: block; + margin-left: auto; + margin-right: auto; +} + +.align-left { + text-align: left; +} + +.align-center { + text-align: center; +} + +.align-default { + text-align: center; +} + +.align-right { + text-align: right; +} + +/* -- sidebars -------------------------------------------------------------- */ + +div.sidebar, +aside.sidebar { + margin: 0 0 0.5em 1em; + border: 1px solid #ddb; + padding: 7px; + background-color: #ffe; + width: 40%; + float: right; + clear: right; + overflow-x: auto; +} + +p.sidebar-title { + font-weight: bold; +} + +nav.contents, +aside.topic, +div.admonition, div.topic, blockquote { + clear: left; +} + +/* -- topics ---------------------------------------------------------------- */ + +nav.contents, +aside.topic, +div.topic { + border: 1px solid #ccc; + padding: 7px; + margin: 10px 0 10px 0; +} + +p.topic-title { + font-size: 1.1em; + font-weight: bold; + margin-top: 10px; +} + +/* -- admonitions ----------------------------------------------------------- */ + +div.admonition { + margin-top: 10px; + margin-bottom: 10px; + padding: 7px; +} + +div.admonition dt { + font-weight: bold; +} + +p.admonition-title { + margin: 0px 10px 5px 0px; + font-weight: bold; +} + +div.body p.centered { + text-align: center; + margin-top: 25px; +} + +/* -- content of sidebars/topics/admonitions -------------------------------- */ + +div.sidebar > :last-child, +aside.sidebar > :last-child, +nav.contents > :last-child, +aside.topic > :last-child, +div.topic > :last-child, +div.admonition > :last-child { + margin-bottom: 0; +} + +div.sidebar::after, +aside.sidebar::after, +nav.contents::after, +aside.topic::after, +div.topic::after, +div.admonition::after, +blockquote::after { + display: block; + content: ''; + clear: both; +} + +/* -- tables ---------------------------------------------------------------- */ + +table.docutils { + margin-top: 10px; + margin-bottom: 10px; + border: 0; + border-collapse: collapse; +} + +table.align-center { + margin-left: auto; + margin-right: auto; +} + +table.align-default { + margin-left: auto; + margin-right: auto; +} + +table caption span.caption-number { + font-style: italic; +} + +table caption span.caption-text { +} + +table.docutils td, table.docutils th { + padding: 1px 8px 1px 5px; + border-top: 0; + border-left: 0; + border-right: 0; + border-bottom: 1px solid #aaa; +} + +th { + text-align: left; + padding-right: 5px; +} + +table.citation { + border-left: solid 1px gray; + margin-left: 1px; +} + +table.citation td { + border-bottom: none; +} + +th > :first-child, +td > :first-child { + margin-top: 0px; +} + +th > :last-child, +td > :last-child { + margin-bottom: 0px; +} + +/* -- figures --------------------------------------------------------------- */ + +div.figure, figure { + margin: 0.5em; + padding: 0.5em; +} + +div.figure p.caption, figcaption { + padding: 0.3em; +} + +div.figure p.caption span.caption-number, +figcaption span.caption-number { + font-style: italic; +} + +div.figure p.caption span.caption-text, +figcaption span.caption-text { +} + +/* -- field list styles ----------------------------------------------------- */ + +table.field-list td, table.field-list th { + border: 0 !important; +} + +.field-list ul { + margin: 0; + padding-left: 1em; +} + +.field-list p { + margin: 0; +} + +.field-name { + -moz-hyphens: manual; + -ms-hyphens: manual; + -webkit-hyphens: manual; + hyphens: manual; +} + +/* -- hlist styles ---------------------------------------------------------- */ + +table.hlist { + margin: 1em 0; +} + +table.hlist td { + vertical-align: top; +} + +/* -- object description styles --------------------------------------------- */ + +.sig { + font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace; +} + +.sig-name, code.descname { + background-color: transparent; + font-weight: bold; +} + +.sig-name { + font-size: 1.1em; +} + +code.descname { + font-size: 1.2em; +} + +.sig-prename, code.descclassname { + background-color: transparent; +} + +.optional { + font-size: 1.3em; +} + +.sig-paren { + font-size: larger; +} + +.sig-param.n { + font-style: italic; +} + +/* C++ specific styling */ + +.sig-inline.c-texpr, +.sig-inline.cpp-texpr { + font-family: unset; +} + +.sig.c .k, .sig.c .kt, +.sig.cpp .k, .sig.cpp .kt { + color: #0033B3; +} + +.sig.c .m, +.sig.cpp .m { + color: #1750EB; +} + +.sig.c .s, .sig.c .sc, +.sig.cpp .s, .sig.cpp .sc { + color: #067D17; +} + + +/* -- other body styles ----------------------------------------------------- */ + +ol.arabic { + list-style: decimal; +} + +ol.loweralpha { + list-style: lower-alpha; +} + +ol.upperalpha { + list-style: upper-alpha; +} + +ol.lowerroman { + list-style: lower-roman; +} + +ol.upperroman { + list-style: upper-roman; +} + +:not(li) > ol > li:first-child > :first-child, +:not(li) > ul > li:first-child > :first-child { + margin-top: 0px; +} + +:not(li) > ol > li:last-child > :last-child, +:not(li) > ul > li:last-child > :last-child { + margin-bottom: 0px; +} + +ol.simple ol p, +ol.simple ul p, +ul.simple ol p, +ul.simple ul p { + margin-top: 0; +} + +ol.simple > li:not(:first-child) > p, +ul.simple > li:not(:first-child) > p { + margin-top: 0; +} + +ol.simple p, +ul.simple p { + margin-bottom: 0; +} + +aside.footnote > span, +div.citation > span { + float: left; +} +aside.footnote > span:last-of-type, +div.citation > span:last-of-type { + padding-right: 0.5em; +} +aside.footnote > p { + margin-left: 2em; +} +div.citation > p { + margin-left: 4em; +} +aside.footnote > p:last-of-type, +div.citation > p:last-of-type { + margin-bottom: 0em; +} +aside.footnote > p:last-of-type:after, +div.citation > p:last-of-type:after { + content: ""; + clear: both; +} + +dl.field-list { + display: grid; + grid-template-columns: fit-content(30%) auto; +} + +dl.field-list > dt { + font-weight: bold; + word-break: break-word; + padding-left: 0.5em; + padding-right: 5px; +} + +dl.field-list > dd { + padding-left: 0.5em; + margin-top: 0em; + margin-left: 0em; + margin-bottom: 0em; +} + +dl { + margin-bottom: 15px; +} + +dd > :first-child { + margin-top: 0px; +} + +dd ul, dd table { + margin-bottom: 10px; +} + +dd { + margin-top: 3px; + margin-bottom: 10px; + margin-left: 30px; +} + +.sig dd { + margin-top: 0px; + margin-bottom: 0px; +} + +.sig dl { + margin-top: 0px; + margin-bottom: 0px; +} + +dl > dd:last-child, +dl > dd:last-child > :last-child { + margin-bottom: 0; +} + +dt:target, span.highlighted { + background-color: #fbe54e; +} + +rect.highlighted { + fill: #fbe54e; +} + +dl.glossary dt { + font-weight: bold; + font-size: 1.1em; +} + +.versionmodified { + font-style: italic; +} + +.system-message { + background-color: #fda; + padding: 5px; + border: 3px solid red; +} + +.footnote:target { + background-color: #ffa; +} + +.line-block { + display: block; + margin-top: 1em; + margin-bottom: 1em; +} + +.line-block .line-block { + margin-top: 0; + margin-bottom: 0; + margin-left: 1.5em; +} + +.guilabel, .menuselection { + font-family: sans-serif; +} + +.accelerator { + text-decoration: underline; +} + +.classifier { + font-style: oblique; +} + +.classifier:before { + font-style: normal; + margin: 0 0.5em; + content: ":"; + display: inline-block; +} + +abbr, acronym { + border-bottom: dotted 1px; + cursor: help; +} + +.translated { + background-color: rgba(207, 255, 207, 0.2) +} + +.untranslated { + background-color: rgba(255, 207, 207, 0.2) +} + +/* -- code displays --------------------------------------------------------- */ + +pre { + overflow: auto; + overflow-y: hidden; /* fixes display issues on Chrome browsers */ +} + +pre, div[class*="highlight-"] { + clear: both; +} + +span.pre { + -moz-hyphens: none; + -ms-hyphens: none; + -webkit-hyphens: none; + hyphens: none; + white-space: nowrap; +} + +div[class*="highlight-"] { + margin: 1em 0; +} + +td.linenos pre { + border: 0; + background-color: transparent; + color: #aaa; +} + +table.highlighttable { + display: block; +} + +table.highlighttable tbody { + display: block; +} + +table.highlighttable tr { + display: flex; +} + +table.highlighttable td { + margin: 0; + padding: 0; +} + +table.highlighttable td.linenos { + padding-right: 0.5em; +} + +table.highlighttable td.code { + flex: 1; + overflow: hidden; +} + +.highlight .hll { + display: block; +} + +div.highlight pre, +table.highlighttable pre { + margin: 0; +} + +div.code-block-caption + div { + margin-top: 0; +} + +div.code-block-caption { + margin-top: 1em; + padding: 2px 5px; + font-size: small; +} + +div.code-block-caption code { + background-color: transparent; +} + +table.highlighttable td.linenos, +span.linenos, +div.highlight span.gp { /* gp: Generic.Prompt */ + user-select: none; + -webkit-user-select: text; /* Safari fallback only */ + -webkit-user-select: none; /* Chrome/Safari */ + -moz-user-select: none; /* Firefox */ + -ms-user-select: none; /* IE10+ */ +} + +div.code-block-caption span.caption-number { + padding: 0.1em 0.3em; + font-style: italic; +} + +div.code-block-caption span.caption-text { +} + +div.literal-block-wrapper { + margin: 1em 0; +} + +code.xref, a code { + background-color: transparent; + font-weight: bold; +} + +h1 code, h2 code, h3 code, h4 code, h5 code, h6 code { + background-color: transparent; +} + +.viewcode-link { + float: right; +} + +.viewcode-back { + float: right; + font-family: sans-serif; +} + +div.viewcode-block:target { + margin: -1px -10px; + padding: 0 10px; +} + +/* -- math display ---------------------------------------------------------- */ + +img.math { + vertical-align: middle; +} + +div.body div.math p { + text-align: center; +} + +span.eqno { + float: right; +} + +span.eqno a.headerlink { + position: absolute; + z-index: 1; +} + +div.math:hover a.headerlink { + visibility: visible; +} + +/* -- printout stylesheet --------------------------------------------------- */ + +@media print { + div.document, + div.documentwrapper, + div.bodywrapper { + margin: 0 !important; + width: 100%; + } + + div.sphinxsidebar, + div.related, + div.footer, + #top-link { + display: none; + } +} \ No newline at end of file diff --git a/docs/_build/html/_static/custom.css b/docs/_build/html/_static/custom.css new file mode 100644 index 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..0398ebb --- /dev/null +++ b/docs/_build/html/_static/doctools.js @@ -0,0 +1,149 @@ +/* + * Base JavaScript utilities for all Sphinx HTML documentation. + */ +"use strict"; + +const BLACKLISTED_KEY_CONTROL_ELEMENTS = new Set([ + "TEXTAREA", + "INPUT", + "SELECT", + "BUTTON", +]); + +const _ready = (callback) => { + if (document.readyState !== "loading") { + callback(); + } else { + document.addEventListener("DOMContentLoaded", callback); + } +}; + +/** + * Small JavaScript module for the documentation. + */ +const Documentation = { + init: () => { + Documentation.initDomainIndexTable(); + Documentation.initOnKeyListeners(); + }, + + /** + * i18n support + */ + TRANSLATIONS: {}, + PLURAL_EXPR: (n) => (n === 1 ? 0 : 1), + LOCALE: "unknown", + + // gettext and ngettext don't access this so that the functions + // can safely bound to a different name (_ = Documentation.gettext) + gettext: (string) => { + const translated = Documentation.TRANSLATIONS[string]; + switch (typeof translated) { + case "undefined": + return string; // no translation + case "string": + return translated; // translation exists + default: + return translated[0]; // (singular, plural) translation tuple exists + } + }, + + ngettext: (singular, plural, n) => { + const translated = Documentation.TRANSLATIONS[singular]; + if (typeof translated !== "undefined") + return translated[Documentation.PLURAL_EXPR(n)]; + return n === 1 ? singular : plural; + }, + + addTranslations: (catalog) => { + Object.assign(Documentation.TRANSLATIONS, catalog.messages); + Documentation.PLURAL_EXPR = new Function( + "n", + `return (${catalog.plural_expr})` + ); + Documentation.LOCALE = catalog.locale; + }, + + /** + * helper function to focus on search bar + */ + focusSearchBar: () => { + document.querySelectorAll("input[name=q]")[0]?.focus(); + }, + + /** + * Initialise the domain index toggle buttons + */ + initDomainIndexTable: () => { + const toggler = (el) => { + const idNumber = el.id.substr(7); + const toggledRows = document.querySelectorAll(`tr.cg-${idNumber}`); + if (el.src.substr(-9) === "minus.png") { + el.src = `${el.src.substr(0, el.src.length - 9)}plus.png`; + toggledRows.forEach((el) => (el.style.display = "none")); + } else { + el.src = `${el.src.substr(0, el.src.length - 8)}minus.png`; + toggledRows.forEach((el) => (el.style.display = "")); + } + }; + + const togglerElements = document.querySelectorAll("img.toggler"); + togglerElements.forEach((el) => + el.addEventListener("click", (event) => toggler(event.currentTarget)) + ); + togglerElements.forEach((el) => (el.style.display = "")); + if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) togglerElements.forEach(toggler); + }, + + initOnKeyListeners: () => { + // only install a listener if it is really needed + if ( + !DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS && + !DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS + ) + return; + + document.addEventListener("keydown", (event) => { + // bail for input elements + if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return; + // bail with special keys + if (event.altKey || event.ctrlKey || event.metaKey) return; + + if (!event.shiftKey) { + switch (event.key) { + case "ArrowLeft": + if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break; + + const prevLink = document.querySelector('link[rel="prev"]'); + if (prevLink && prevLink.href) { + window.location.href = prevLink.href; + event.preventDefault(); + } + break; + case "ArrowRight": + if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break; + + const nextLink = document.querySelector('link[rel="next"]'); + if (nextLink && nextLink.href) { + window.location.href = nextLink.href; + event.preventDefault(); + } + break; + } + } + + // some keyboard layouts may need Shift to get / + switch (event.key) { + case "/": + if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) break; + Documentation.focusSearchBar(); + event.preventDefault(); + } + }); + }, +}; + +// quick alias for translations +const _ = Documentation.gettext; + +_ready(Documentation.init); diff --git a/docs/_build/html/_static/documentation_options.js b/docs/_build/html/_static/documentation_options.js new file mode 100644 index 0000000..e21c068 --- /dev/null +++ b/docs/_build/html/_static/documentation_options.js @@ -0,0 +1,13 @@ +const DOCUMENTATION_OPTIONS = { + VERSION: '0.1', + LANGUAGE: 'en', + COLLAPSE_INDEX: false, + BUILDER: 'html', + FILE_SUFFIX: '.html', + LINK_SUFFIX: '.html', + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '.txt', + NAVIGATION_WITH_KEYS: false, + SHOW_SEARCH_SUMMARY: true, + ENABLE_SEARCH_SHORTCUTS: true, +}; \ No newline at end of file diff --git a/docs/_build/html/_static/file.png b/docs/_build/html/_static/file.png new file mode 100644 index 0000000000000000000000000000000000000000..a858a410e4faa62ce324d814e4b816fff83a6fb3 GIT binary patch literal 286 zcmV+(0pb3MP)s`hMrGg#P~ix$^RISR_I47Y|r1 z_CyJOe}D1){SET-^Amu_i71Lt6eYfZjRyw@I6OQAIXXHDfiX^GbOlHe=Ae4>0m)d(f|Me07*qoM6N<$f}vM^LjV8( literal 0 HcmV?d00001 diff --git a/docs/_build/html/_static/language_data.js b/docs/_build/html/_static/language_data.js new file mode 100644 index 0000000..c7fe6c6 --- /dev/null +++ b/docs/_build/html/_static/language_data.js @@ -0,0 +1,192 @@ +/* + * This script contains the language-specific data used by searchtools.js, + * namely the list of stopwords, stemmer, scorer and splitter. + */ + +var stopwords = ["a", "and", "are", "as", "at", "be", "but", "by", "for", "if", "in", "into", "is", "it", "near", "no", "not", "of", "on", "or", "such", "that", "the", "their", "then", "there", "these", "they", "this", "to", "was", "will", "with"]; + + +/* Non-minified version is copied as a separate JS file, if available */ + +/** + * Porter Stemmer + */ +var Stemmer = function() { + + var step2list = { + ational: 'ate', + tional: 'tion', + enci: 'ence', + anci: 'ance', + izer: 'ize', + bli: 'ble', + alli: 'al', + entli: 'ent', + eli: 'e', + ousli: 'ous', + ization: 'ize', + ation: 'ate', + ator: 'ate', + alism: 'al', + iveness: 'ive', + fulness: 'ful', + ousness: 'ous', + aliti: 'al', + iviti: 'ive', + biliti: 'ble', + logi: 'log' + }; + + var step3list = { + icate: 'ic', + ative: '', + alize: 'al', + iciti: 'ic', + ical: 'ic', + ful: '', + ness: '' + }; + + var c = "[^aeiou]"; // consonant + var v = "[aeiouy]"; // vowel + var C = c + "[^aeiouy]*"; // consonant sequence + var V = v + "[aeiou]*"; // vowel sequence + + var mgr0 = "^(" + C + ")?" + V + C; // [C]VC... is m>0 + var meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$"; // [C]VC[V] is m=1 + var mgr1 = "^(" + C + ")?" + V + C + V + C; // [C]VCVC... is m>1 + var s_v = "^(" + C + ")?" + v; // vowel in stem + + this.stemWord = function (w) { + var stem; + var suffix; + var firstch; + var origword = w; + + if (w.length < 3) + return w; + + var re; + var re2; + var re3; + var re4; + + firstch = w.substr(0,1); + if (firstch == "y") + w = firstch.toUpperCase() + w.substr(1); + + // Step 1a + re = /^(.+?)(ss|i)es$/; + re2 = /^(.+?)([^s])s$/; + + if (re.test(w)) + w = w.replace(re,"$1$2"); + else if (re2.test(w)) + w = w.replace(re2,"$1$2"); + + // Step 1b + re = /^(.+?)eed$/; + re2 = /^(.+?)(ed|ing)$/; + if (re.test(w)) { + var fp = re.exec(w); + re = new RegExp(mgr0); + if (re.test(fp[1])) { + re = /.$/; + w = w.replace(re,""); + } + } + else if (re2.test(w)) { + var fp = re2.exec(w); + stem = fp[1]; + re2 = new RegExp(s_v); + if (re2.test(stem)) { + w = stem; + re2 = /(at|bl|iz)$/; + re3 = new RegExp("([^aeiouylsz])\\1$"); + re4 = new RegExp("^" + C + v + "[^aeiouwxy]$"); + if (re2.test(w)) + w = w + "e"; + else if (re3.test(w)) { + re = /.$/; + w = w.replace(re,""); + } + else if (re4.test(w)) + w = w + "e"; + } + } + + // Step 1c + re = /^(.+?)y$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(s_v); + if (re.test(stem)) + w = stem + "i"; + } + + // Step 2 + re = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + suffix = fp[2]; + re = new RegExp(mgr0); + if (re.test(stem)) + w = stem + step2list[suffix]; + } + + // Step 3 + re = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + suffix = fp[2]; + re = new RegExp(mgr0); + if (re.test(stem)) + w = stem + step3list[suffix]; + } + + // Step 4 + re = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/; + re2 = /^(.+?)(s|t)(ion)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(mgr1); + if (re.test(stem)) + w = stem; + } + else if (re2.test(w)) { + var fp = re2.exec(w); + stem = fp[1] + fp[2]; + re2 = new RegExp(mgr1); + if (re2.test(stem)) + w = stem; + } + + // Step 5 + re = /^(.+?)e$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(mgr1); + re2 = new RegExp(meq1); + re3 = new RegExp("^" + C + v + "[^aeiouwxy]$"); + if (re.test(stem) || (re2.test(stem) && !(re3.test(stem)))) + w = stem; + } + re = /ll$/; + re2 = new RegExp(mgr1); + if (re.test(w) && re2.test(w)) { + re = /.$/; + w = w.replace(re,""); + } + + // and turn initial Y back to y + if (firstch == "y") + w = firstch.toLowerCase() + w.substr(1); + return w; + } +} + diff --git a/docs/_build/html/_static/minus.png b/docs/_build/html/_static/minus.png new file mode 100644 index 0000000000000000000000000000000000000000..d96755fdaf8bb2214971e0db9c1fd3077d7c419d GIT binary patch literal 90 zcmeAS@N?(olHy`uVBq!ia0vp^+#t*WBp7;*Yy1LIik>cxAr*|t7R?Mi>2?kWtu=nj kDsEF_5m^0CR;1wuP-*O&G^0G}KYk!hp00i_>zopr08q^qX#fBK literal 0 HcmV?d00001 diff --git a/docs/_build/html/_static/plus.png b/docs/_build/html/_static/plus.png new file mode 100644 index 0000000000000000000000000000000000000000..7107cec93a979b9a5f64843235a16651d563ce2d GIT binary patch literal 90 zcmeAS@N?(olHy`uVBq!ia0vp^+#t*WBp7;*Yy1LIik>cxAr*|t7R?Mi>2?kWtu>-2 m3q%Vub%g%s<8sJhVPMczOq}xhg9DJoz~JfX=d#Wzp$Pyb1r*Kz literal 0 HcmV?d00001 diff --git a/docs/_build/html/_static/pygments.css b/docs/_build/html/_static/pygments.css new file mode 100644 index 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..2c774d1 --- /dev/null +++ b/docs/_build/html/_static/searchtools.js @@ -0,0 +1,632 @@ +/* + * Sphinx JavaScript utilities for the full-text search. + */ +"use strict"; + +/** + * Simple result scoring code. + */ +if (typeof Scorer === "undefined") { + var Scorer = { + // Implement the following function to further tweak the score for each result + // The function takes a result array [docname, title, anchor, descr, score, filename] + // and returns the new score. + /* + score: result => { + const [docname, title, anchor, descr, score, filename, kind] = result + return score + }, + */ + + // query matches the full name of an object + objNameMatch: 11, + // or matches in the last dotted part of the object name + objPartialMatch: 6, + // Additive scores depending on the priority of the object + objPrio: { + 0: 15, // used to be importantResults + 1: 5, // used to be objectResults + 2: -5, // used to be unimportantResults + }, + // Used when the priority is not in the mapping. + objPrioDefault: 0, + + // query found in title + title: 15, + partialTitle: 7, + // query found in terms + term: 5, + partialTerm: 2, + }; +} + +// Global search result kind enum, used by themes to style search results. +class SearchResultKind { + static get index() { return "index"; } + static get object() { return "object"; } + static get text() { return "text"; } + static get title() { return "title"; } +} + +const _removeChildren = (element) => { + while (element && element.lastChild) element.removeChild(element.lastChild); +}; + +/** + * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions#escaping + */ +const _escapeRegExp = (string) => + string.replace(/[.*+\-?^${}()|[\]\\]/g, "\\$&"); // $& means the whole matched string + +const _displayItem = (item, searchTerms, highlightTerms) => { + const docBuilder = DOCUMENTATION_OPTIONS.BUILDER; + const docFileSuffix = DOCUMENTATION_OPTIONS.FILE_SUFFIX; + const docLinkSuffix = DOCUMENTATION_OPTIONS.LINK_SUFFIX; + const showSearchSummary = DOCUMENTATION_OPTIONS.SHOW_SEARCH_SUMMARY; + const contentRoot = document.documentElement.dataset.content_root; + + const [docName, title, anchor, descr, score, _filename, kind] = item; + + let listItem = document.createElement("li"); + // Add a class representing the item's type: + // can be used by a theme's CSS selector for styling + // See SearchResultKind for the class names. + listItem.classList.add(`kind-${kind}`); + let requestUrl; + let linkUrl; + if (docBuilder === "dirhtml") { + // dirhtml builder + let dirname = docName + "/"; + if (dirname.match(/\/index\/$/)) + dirname = dirname.substring(0, dirname.length - 6); + else if (dirname === "index/") dirname = ""; + requestUrl = contentRoot + dirname; + linkUrl = requestUrl; + } else { + // normal html builders + requestUrl = contentRoot + docName + docFileSuffix; + linkUrl = docName + docLinkSuffix; + } + let linkEl = listItem.appendChild(document.createElement("a")); + linkEl.href = linkUrl + anchor; + linkEl.dataset.score = score; + linkEl.innerHTML = title; + if (descr) { + listItem.appendChild(document.createElement("span")).innerHTML = + " (" + descr + ")"; + // highlight search terms in the description + if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js + highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted")); + } + else if (showSearchSummary) + fetch(requestUrl) + .then((responseData) => responseData.text()) + .then((data) => { + if (data) + listItem.appendChild( + Search.makeSearchSummary(data, searchTerms, anchor) + ); + // highlight search terms in the summary + if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js + highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted")); + }); + Search.output.appendChild(listItem); +}; +const _finishSearch = (resultCount) => { + Search.stopPulse(); + Search.title.innerText = _("Search Results"); + if (!resultCount) + Search.status.innerText = Documentation.gettext( + "Your search did not match any documents. Please make sure that all words are spelled correctly and that you've selected enough categories." + ); + else + Search.status.innerText = Documentation.ngettext( + "Search finished, found one page matching the search query.", + "Search finished, found ${resultCount} pages matching the search query.", + resultCount, + ).replace('${resultCount}', resultCount); +}; +const _displayNextItem = ( + results, + resultCount, + searchTerms, + highlightTerms, +) => { + // results left, load the summary and display it + // this is intended to be dynamic (don't sub resultsCount) + if (results.length) { + _displayItem(results.pop(), searchTerms, highlightTerms); + setTimeout( + () => _displayNextItem(results, resultCount, searchTerms, highlightTerms), + 5 + ); + } + // search finished, update title and status message + else _finishSearch(resultCount); +}; +// Helper function used by query() to order search results. +// Each input is an array of [docname, title, anchor, descr, score, filename, kind]. +// Order the results by score (in opposite order of appearance, since the +// `_displayNextItem` function uses pop() to retrieve items) and then alphabetically. +const _orderResultsByScoreThenName = (a, b) => { + const leftScore = a[4]; + const rightScore = b[4]; + if (leftScore === rightScore) { + // same score: sort alphabetically + const leftTitle = a[1].toLowerCase(); + const rightTitle = b[1].toLowerCase(); + if (leftTitle === rightTitle) return 0; + return leftTitle > rightTitle ? -1 : 1; // inverted is intentional + } + return leftScore > rightScore ? 1 : -1; +}; + +/** + * Default splitQuery function. Can be overridden in ``sphinx.search`` with a + * custom function per language. + * + * The regular expression works by splitting the string on consecutive characters + * that are not Unicode letters, numbers, underscores, or emoji characters. + * This is the same as ``\W+`` in Python, preserving the surrogate pair area. + */ +if (typeof splitQuery === "undefined") { + var splitQuery = (query) => query + .split(/[^\p{Letter}\p{Number}_\p{Emoji_Presentation}]+/gu) + .filter(term => term) // remove remaining empty strings +} + +/** + * Search Module + */ +const Search = { + _index: null, + _queued_query: null, + _pulse_status: -1, + + htmlToText: (htmlString, anchor) => { + const htmlElement = new DOMParser().parseFromString(htmlString, 'text/html'); + for (const removalQuery of [".headerlink", "script", "style"]) { + htmlElement.querySelectorAll(removalQuery).forEach((el) => { el.remove() }); + } + if (anchor) { + const anchorContent = htmlElement.querySelector(`[role="main"] ${anchor}`); + if (anchorContent) return anchorContent.textContent; + + console.warn( + `Anchored content block not found. Sphinx search tries to obtain it via DOM query '[role=main] ${anchor}'. Check your theme or template.` + ); + } + + // if anchor not specified or not found, fall back to main content + const docContent = htmlElement.querySelector('[role="main"]'); + if (docContent) return docContent.textContent; + + console.warn( + "Content block not found. Sphinx search tries to obtain it via DOM query '[role=main]'. Check your theme or template." + ); + return ""; + }, + + init: () => { + const query = new URLSearchParams(window.location.search).get("q"); + document + .querySelectorAll('input[name="q"]') + .forEach((el) => (el.value = query)); + if (query) Search.performSearch(query); + }, + + loadIndex: (url) => + (document.body.appendChild(document.createElement("script")).src = url), + + setIndex: (index) => { + Search._index = index; + if (Search._queued_query !== null) { + const query = Search._queued_query; + Search._queued_query = null; + Search.query(query); + } + }, + + hasIndex: () => Search._index !== null, + + deferQuery: (query) => (Search._queued_query = query), + + stopPulse: () => (Search._pulse_status = -1), + + startPulse: () => { + if (Search._pulse_status >= 0) return; + + const pulse = () => { + Search._pulse_status = (Search._pulse_status + 1) % 4; + Search.dots.innerText = ".".repeat(Search._pulse_status); + if (Search._pulse_status >= 0) window.setTimeout(pulse, 500); + }; + pulse(); + }, + + /** + * perform a search for something (or wait until index is loaded) + */ + performSearch: (query) => { + // create the required interface elements + const searchText = document.createElement("h2"); + searchText.textContent = _("Searching"); + const searchSummary = document.createElement("p"); + searchSummary.classList.add("search-summary"); + searchSummary.innerText = ""; + const searchList = document.createElement("ul"); + searchList.setAttribute("role", "list"); + searchList.classList.add("search"); + + const out = document.getElementById("search-results"); + Search.title = out.appendChild(searchText); + Search.dots = Search.title.appendChild(document.createElement("span")); + Search.status = out.appendChild(searchSummary); + Search.output = out.appendChild(searchList); + + const searchProgress = document.getElementById("search-progress"); + // Some themes don't use the search progress node + if (searchProgress) { + searchProgress.innerText = _("Preparing search..."); + } + Search.startPulse(); + + // index already loaded, the browser was quick! + if (Search.hasIndex()) Search.query(query); + else Search.deferQuery(query); + }, + + _parseQuery: (query) => { + // stem the search terms and add them to the correct list + const stemmer = new Stemmer(); + const searchTerms = new Set(); + const excludedTerms = new Set(); + const highlightTerms = new Set(); + const objectTerms = new Set(splitQuery(query.toLowerCase().trim())); + splitQuery(query.trim()).forEach((queryTerm) => { + const queryTermLower = queryTerm.toLowerCase(); + + // maybe skip this "word" + // stopwords array is from language_data.js + if ( + stopwords.indexOf(queryTermLower) !== -1 || + queryTerm.match(/^\d+$/) + ) + return; + + // stem the word + let word = stemmer.stemWord(queryTermLower); + // select the correct list + if (word[0] === "-") excludedTerms.add(word.substr(1)); + else { + searchTerms.add(word); + highlightTerms.add(queryTermLower); + } + }); + + if (SPHINX_HIGHLIGHT_ENABLED) { // set in sphinx_highlight.js + localStorage.setItem("sphinx_highlight_terms", [...highlightTerms].join(" ")) + } + + // console.debug("SEARCH: searching for:"); + // console.info("required: ", [...searchTerms]); + // console.info("excluded: ", [...excludedTerms]); + + return [query, searchTerms, excludedTerms, highlightTerms, objectTerms]; + }, + + /** + * execute search (requires search index to be loaded) + */ + _performSearch: (query, searchTerms, excludedTerms, highlightTerms, objectTerms) => { + const filenames = Search._index.filenames; + const docNames = Search._index.docnames; + const titles = Search._index.titles; + const allTitles = Search._index.alltitles; + const indexEntries = Search._index.indexentries; + + // Collect multiple result groups to be sorted separately and then ordered. + // Each is an array of [docname, title, anchor, descr, score, filename, kind]. + const normalResults = []; + const nonMainIndexResults = []; + + _removeChildren(document.getElementById("search-progress")); + + const queryLower = query.toLowerCase().trim(); + for (const [title, foundTitles] of Object.entries(allTitles)) { + if (title.toLowerCase().trim().includes(queryLower) && (queryLower.length >= title.length/2)) { + for (const [file, id] of foundTitles) { + const score = Math.round(Scorer.title * queryLower.length / title.length); + const boost = titles[file] === title ? 1 : 0; // add a boost for document titles + normalResults.push([ + docNames[file], + titles[file] !== title ? `${titles[file]} > ${title}` : title, + id !== null ? "#" + id : "", + null, + score + boost, + filenames[file], + SearchResultKind.title, + ]); + } + } + } + + // search for explicit entries in index directives + for (const [entry, foundEntries] of Object.entries(indexEntries)) { + if (entry.includes(queryLower) && (queryLower.length >= entry.length/2)) { + for (const [file, id, isMain] of foundEntries) { + const score = Math.round(100 * queryLower.length / entry.length); + const result = [ + docNames[file], + titles[file], + id ? "#" + id : "", + null, + score, + filenames[file], + SearchResultKind.index, + ]; + if (isMain) { + normalResults.push(result); + } else { + nonMainIndexResults.push(result); + } + } + } + } + + // lookup as object + objectTerms.forEach((term) => + normalResults.push(...Search.performObjectSearch(term, objectTerms)) + ); + + // lookup as search terms in fulltext + normalResults.push(...Search.performTermsSearch(searchTerms, excludedTerms)); + + // let the scorer override scores with a custom scoring function + if (Scorer.score) { + normalResults.forEach((item) => (item[4] = Scorer.score(item))); + nonMainIndexResults.forEach((item) => (item[4] = Scorer.score(item))); + } + + // Sort each group of results by score and then alphabetically by name. + normalResults.sort(_orderResultsByScoreThenName); + nonMainIndexResults.sort(_orderResultsByScoreThenName); + + // Combine the result groups in (reverse) order. + // Non-main index entries are typically arbitrary cross-references, + // so display them after other results. + let results = [...nonMainIndexResults, ...normalResults]; + + // remove duplicate search results + // note the reversing of results, so that in the case of duplicates, the highest-scoring entry is kept + let seen = new Set(); + results = results.reverse().reduce((acc, result) => { + let resultStr = result.slice(0, 4).concat([result[5]]).map(v => String(v)).join(','); + if (!seen.has(resultStr)) { + acc.push(result); + seen.add(resultStr); + } + return acc; + }, []); + + return results.reverse(); + }, + + query: (query) => { + const [searchQuery, searchTerms, excludedTerms, highlightTerms, objectTerms] = Search._parseQuery(query); + const results = Search._performSearch(searchQuery, searchTerms, excludedTerms, highlightTerms, objectTerms); + + // for debugging + //Search.lastresults = results.slice(); // a copy + // console.info("search results:", Search.lastresults); + + // print the results + _displayNextItem(results, results.length, searchTerms, highlightTerms); + }, + + /** + * search for object names + */ + performObjectSearch: (object, objectTerms) => { + const filenames = Search._index.filenames; + const docNames = Search._index.docnames; + const objects = Search._index.objects; + const objNames = Search._index.objnames; + const titles = Search._index.titles; + + const results = []; + + const objectSearchCallback = (prefix, match) => { + const name = match[4] + const fullname = (prefix ? prefix + "." : "") + name; + const fullnameLower = fullname.toLowerCase(); + if (fullnameLower.indexOf(object) < 0) return; + + let score = 0; + const parts = fullnameLower.split("."); + + // check for different match types: exact matches of full name or + // "last name" (i.e. last dotted part) + if (fullnameLower === object || parts.slice(-1)[0] === object) + score += Scorer.objNameMatch; + else if (parts.slice(-1)[0].indexOf(object) > -1) + score += Scorer.objPartialMatch; // matches in last name + + const objName = objNames[match[1]][2]; + const title = titles[match[0]]; + + // If more than one term searched for, we require other words to be + // found in the name/title/description + const otherTerms = new Set(objectTerms); + otherTerms.delete(object); + if (otherTerms.size > 0) { + const haystack = `${prefix} ${name} ${objName} ${title}`.toLowerCase(); + if ( + [...otherTerms].some((otherTerm) => haystack.indexOf(otherTerm) < 0) + ) + return; + } + + let anchor = match[3]; + if (anchor === "") anchor = fullname; + else if (anchor === "-") anchor = objNames[match[1]][1] + "-" + fullname; + + const descr = objName + _(", in ") + title; + + // add custom score for some objects according to scorer + if (Scorer.objPrio.hasOwnProperty(match[2])) + score += Scorer.objPrio[match[2]]; + else score += Scorer.objPrioDefault; + + results.push([ + docNames[match[0]], + fullname, + "#" + anchor, + descr, + score, + filenames[match[0]], + SearchResultKind.object, + ]); + }; + Object.keys(objects).forEach((prefix) => + objects[prefix].forEach((array) => + objectSearchCallback(prefix, array) + ) + ); + return results; + }, + + /** + * search for full-text terms in the index + */ + performTermsSearch: (searchTerms, excludedTerms) => { + // prepare search + const terms = Search._index.terms; + const titleTerms = Search._index.titleterms; + const filenames = Search._index.filenames; + const docNames = Search._index.docnames; + const titles = Search._index.titles; + + const scoreMap = new Map(); + const fileMap = new Map(); + + // perform the search on the required terms + searchTerms.forEach((word) => { + const files = []; + const arr = [ + { files: terms[word], score: Scorer.term }, + { files: titleTerms[word], score: Scorer.title }, + ]; + // add support for partial matches + if (word.length > 2) { + const escapedWord = _escapeRegExp(word); + if (!terms.hasOwnProperty(word)) { + Object.keys(terms).forEach((term) => { + if (term.match(escapedWord)) + arr.push({ files: terms[term], score: Scorer.partialTerm }); + }); + } + if (!titleTerms.hasOwnProperty(word)) { + Object.keys(titleTerms).forEach((term) => { + if (term.match(escapedWord)) + arr.push({ files: titleTerms[term], score: Scorer.partialTitle }); + }); + } + } + + // no match but word was a required one + if (arr.every((record) => record.files === undefined)) return; + + // found search word in contents + arr.forEach((record) => { + if (record.files === undefined) return; + + let recordFiles = record.files; + if (recordFiles.length === undefined) recordFiles = [recordFiles]; + files.push(...recordFiles); + + // set score for the word in each file + recordFiles.forEach((file) => { + if (!scoreMap.has(file)) scoreMap.set(file, {}); + scoreMap.get(file)[word] = record.score; + }); + }); + + // create the mapping + files.forEach((file) => { + if (!fileMap.has(file)) fileMap.set(file, [word]); + else if (fileMap.get(file).indexOf(word) === -1) fileMap.get(file).push(word); + }); + }); + + // now check if the files don't contain excluded terms + const results = []; + for (const [file, wordList] of fileMap) { + // check if all requirements are matched + + // as search terms with length < 3 are discarded + const filteredTermCount = [...searchTerms].filter( + (term) => term.length > 2 + ).length; + if ( + wordList.length !== searchTerms.size && + wordList.length !== filteredTermCount + ) + continue; + + // ensure that none of the excluded terms is in the search result + if ( + [...excludedTerms].some( + (term) => + terms[term] === file || + titleTerms[term] === file || + (terms[term] || []).includes(file) || + (titleTerms[term] || []).includes(file) + ) + ) + break; + + // select one (max) score for the file. + const score = Math.max(...wordList.map((w) => scoreMap.get(file)[w])); + // add result to the result list + results.push([ + docNames[file], + titles[file], + "", + null, + score, + filenames[file], + SearchResultKind.text, + ]); + } + return results; + }, + + /** + * helper function to return a node containing the + * search summary for a given text. keywords is a list + * of stemmed words. + */ + makeSearchSummary: (htmlText, keywords, anchor) => { + const text = Search.htmlToText(htmlText, anchor); + if (text === "") return null; + + const textLower = text.toLowerCase(); + const actualStartPosition = [...keywords] + .map((k) => textLower.indexOf(k.toLowerCase())) + .filter((i) => i > -1) + .slice(-1)[0]; + const startWithContext = Math.max(actualStartPosition - 120, 0); + + const top = startWithContext === 0 ? "" : "..."; + const tail = startWithContext + 240 < text.length ? "..." : ""; + + let summary = document.createElement("p"); + summary.classList.add("context"); + summary.textContent = top + text.substr(startWithContext, 240).trim() + tail; + + return summary; + }, +}; + +_ready(Search.init); diff --git a/docs/_build/html/_static/sphinx_highlight.js b/docs/_build/html/_static/sphinx_highlight.js new file mode 100644 index 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/content/average-squares-docs.html b/docs/_build/html/content/average-squares-docs.html new file mode 100644 index 0000000..2e7bf14 --- /dev/null +++ b/docs/_build/html/content/average-squares-docs.html @@ -0,0 +1,144 @@ + + + + + + + + Average Squares Documentation — Squares 0.1 documentation + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

Average Squares Documentation

+

Computation of weighted average of squares.

+
+
+squares.average_of_squares(list_of_numbers, list_of_weights=None)
+

Return the weighted average of a list of values.

+

By default, all values are equally weighted, but this can be changed +by the list_of_weights argument.

+
+

Example:

+
>>> average_of_squares([1, 2, 4])
+7.0
+>>> average_of_squares([2, 4], [1, 0.5])
+8.0
+>>> average_of_squares([1, 2, 4], [1, 0.5])
+Traceback (most recent call last):
+AssertionError: weights and numbers must have same length
+
+
+
+
+ +
+
+squares.convert_numbers(list_of_strings)
+

Convert a list of strings into numbers, ignoring whitespace.

+
+

Example:

+
>>> convert_numbers(["4", " 8 ", "15 16", " 23    42 "])
+[4.0, 8.0, 15.0, 16.0, 23.0, 42.0]
+
+
+
+
+ +
+ + +
+ +
+
+ +
+
+
+ ©2024, Erie Fang. + + | + Powered by Sphinx 8.1.3 + & Alabaster 0.7.16 + + | + Page source +
+ + + + + + \ No newline at end of file diff --git a/docs/_build/html/genindex.html b/docs/_build/html/genindex.html new file mode 100644 index 0000000..bb8900e --- /dev/null +++ b/docs/_build/html/genindex.html @@ -0,0 +1,149 @@ + + + + + + + Index — Squares 0.1 documentation + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ + +

Index

+ +
+ A + | C + | M + | S + +
+

A

+ + +
+ +

C

+ + +
+ +

M

+ + +
+ +

S

+ + +
    +
  • + squares + +
    • +
+ + + +
+ +
+
+ +
+
+
+ ©2024, Erie Fang. + + | + Powered by Sphinx 8.1.3 + & 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..bedc8da --- /dev/null +++ b/docs/_build/html/index.html @@ -0,0 +1,123 @@ + + + + + + + + Squares documentation — Squares 0.1 documentation + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

Squares documentation

+
    +

  • Return the weighted average of a list of values.

    • +

  • Convert a list of strings into numbers, ignoring whitespace.

    • +
+

Add your content using reStructuredText syntax. See the +reStructuredText +documentation for details.

+
+

Contents:

+ +
+
+ + +
+ +
+
+ +
+
+
+ ©2024, Erie Fang. + + | + Powered by Sphinx 8.1.3 + & 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 0000000..30af8ad --- /dev/null +++ b/docs/_build/html/objects.inv @@ -0,0 +1,7 @@ +# Sphinx inventory version 2 +# Project: Squares +# Version: +# The remainder of this file is compressed using zlib. +xڝM +0=ŀnSu۝ƅ x&h$booꤴn7;ޡO-]Eew/0K-(q0:O̝ ++sw{Mk2c}s248>*%f + + + + + + Python Module Index — Squares 0.1 documentation + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ + +

Python Module Index

+ +
+ s +
+ + + + + + + +
 
+ s
+ squares +
+ + +
+ +
+
+ +
+
+
+ ©2024, Erie Fang. + + | + Powered by Sphinx 8.1.3 + & Alabaster 0.7.16 + +
+ + + + + + \ No newline at end of file diff --git a/docs/_build/html/search.html b/docs/_build/html/search.html new file mode 100644 index 0000000..d88a0a2 --- /dev/null +++ b/docs/_build/html/search.html @@ -0,0 +1,120 @@ + + + + + + + Search — Squares 0.1 documentation + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +

Search

+ + + + +

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

+ + +
+ + + +
+ + +
+ + +
+ +
+
+ +
+
+
+ ©2024, Erie Fang. + + | + Powered by Sphinx 8.1.3 + & 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..14c4850 --- /dev/null +++ b/docs/_build/html/searchindex.js @@ -0,0 +1 @@ +Search.setIndex({"alltitles": {"Average Squares Documentation": [[0, null]], "Contents:": [[1, null]], "Example:": [[0, "example"], [0, "id1"]], "Squares documentation": [[1, null]]}, "docnames": ["content/average-squares-docs", "index"], "envversion": {"sphinx": 64, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2}, "filenames": ["content/average-squares-docs.rst", "index.rst"], "indexentries": {"average_of_squares() (in module squares)": [[0, "squares.average_of_squares", false]], "convert_numbers() (in module squares)": [[0, "squares.convert_numbers", false]], "module": [[0, "module-squares", false]], "squares": [[0, "module-squares", false]]}, "objects": {"": [[0, 0, 0, "-", "squares"]], "squares": [[0, 1, 1, "", "average_of_squares"], [0, 1, 1, "", "convert_numbers"]]}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"]}, "objtypes": {"0": "py:module", "1": "py:function"}, "terms": {"0": 0, "1": 0, "15": 0, "16": 0, "2": 0, "23": 0, "4": 0, "42": 0, "5": 0, "7": 0, "8": 0, "By": 0, "add": 1, "all": 0, "ar": 0, "argument": 0, "assertionerror": 0, "averag": 1, "average_of_squar": [0, 1], "call": 0, "can": 0, "chang": 0, "comput": 0, "content": [], "convert": [0, 1], "convert_numb": [0, 1], "default": 0, "detail": 1, "equal": 0, "have": 0, "ignor": [0, 1], "last": 0, "length": 0, "list": [0, 1], "list_of_numb": 0, "list_of_str": 0, "list_of_weight": 0, "most": 0, "must": 0, "none": 0, "number": [0, 1], "recent": 0, "restructuredtext": 1, "return": [0, 1], "same": 0, "see": 1, "string": [0, 1], "syntax": 1, "thi": 0, "traceback": 0, "us": 1, "valu": [0, 1], "weight": [0, 1], "whitespac": [0, 1], "your": 1}, "titles": ["Average Squares Documentation", "Squares documentation"], "titleterms": {"averag": 0, "content": 1, "document": [0, 1], "exampl": 0, "squar": [0, 1]}}) \ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..d57fbef --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,36 @@ +# Configuration file for the Sphinx documentation builder. +# +# For the full list of built-in configuration values, see the documentation: +# https://www.sphinx-doc.org/en/master/usage/configuration.html + +# -- Project information ----------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information + +project = 'Squares' +copyright = '2024, Erie Fang' +author = 'Erie Fang' +release = '0.1' + +# -- Path setup -------------------------------------------------------------- + +import os +import sys +sys.path.insert(0, os.path.abspath('..')) + +# -- General configuration --------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration + +extensions = [ + 'sphinx.ext.autodoc' +] + +templates_path = ['_templates'] +exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] + + + +# -- 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/content/average-squares-docs.rst b/docs/content/average-squares-docs.rst new file mode 100644 index 0000000..86be196 --- /dev/null +++ b/docs/content/average-squares-docs.rst @@ -0,0 +1,6 @@ +Average Squares Documentation +============================= +.. automodule:: squares + :members: + :undoc-members: + :show-inheritance: \ No newline at end of file diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..520bd7b --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,21 @@ +.. Squares documentation master file, created by + sphinx-quickstart on Sun Nov 17 00:51:57 2024. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Squares documentation +===================== +- Return the weighted average of a list of values. +- Convert a list of strings into numbers, ignoring whitespace. + +Add your content using ``reStructuredText`` syntax. See the +`reStructuredText `_ +documentation for details. + + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + content/average-squares-docs + diff --git a/docs/make.bat b/docs/make.bat new file mode 100644 index 0000000..32bb245 --- /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=. +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 From 807b5edc9ca5efcbb9046d4d2475d1f8f5c2cbac Mon Sep 17 00:00:00 2001 From: Erie Date: Mon, 18 Nov 2024 09:46:50 +0000 Subject: [PATCH 4/6] add argument parse --- squares.py | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-) diff --git a/squares.py b/squares.py index 8b83fca..b52a420 100644 --- a/squares.py +++ b/squares.py @@ -1,4 +1,5 @@ """Computation of weighted average of squares.""" +from argparse import ArgumentParser def average_of_squares(list_of_numbers, list_of_weights=None): @@ -51,11 +52,19 @@ def convert_numbers(list_of_strings): if __name__ == "__main__": - numbers_strings = ["1","2","4"] - weight_strings = ["1","1","1"] + # numbers_strings = ["1","2","4"] + # weight_strings = ["1","1","1"] + weight_strings = None + parser = ArgumentParser(description='weighted average of a list of values') + parser.add_argument('numbers',nargs='+') + parser.add_argument('--weight','-w') + arguments = parser.parse_args() - numbers = convert_numbers(numbers_strings) - weights = convert_numbers(weight_strings) + numbers = convert_numbers(arguments.numbers) + if arguments.weight: + weights = convert_numbers(arguments.weight) + else: + weights = None result = average_of_squares(numbers, weights) From 9d69d6b70b8e2b6972547abdd64b3e43d2b4c865 Mon Sep 17 00:00:00 2001 From: Erie Date: Mon, 18 Nov 2024 09:55:27 +0000 Subject: [PATCH 5/6] add weights as argument --- squares.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/squares.py b/squares.py index b52a420..04482e5 100644 --- a/squares.py +++ b/squares.py @@ -57,12 +57,12 @@ def convert_numbers(list_of_strings): weight_strings = None parser = ArgumentParser(description='weighted average of a list of values') parser.add_argument('numbers',nargs='+') - parser.add_argument('--weight','-w') + parser.add_argument('--weights','-w', nargs='+') arguments = parser.parse_args() numbers = convert_numbers(arguments.numbers) - if arguments.weight: - weights = convert_numbers(arguments.weight) + if arguments.weights: + weights = convert_numbers(arguments.weights) else: weights = None From 89c26b771a05d99895db0016619f5289fe5a027f Mon Sep 17 00:00:00 2001 From: Erie Date: Mon, 18 Nov 2024 10:22:37 +0000 Subject: [PATCH 6/6] read txt file with a sample file --- numbers.txt | 1 + squares.py | 14 ++++++++++---- 2 files changed, 11 insertions(+), 4 deletions(-) create mode 100644 numbers.txt diff --git a/numbers.txt b/numbers.txt new file mode 100644 index 0000000..7477290 --- /dev/null +++ b/numbers.txt @@ -0,0 +1 @@ +2, 3, 4 \ No newline at end of file diff --git a/squares.py b/squares.py index 04482e5..9ebf2ba 100644 --- a/squares.py +++ b/squares.py @@ -1,5 +1,6 @@ """Computation of weighted average of squares.""" from argparse import ArgumentParser +import numpy as np def average_of_squares(list_of_numbers, list_of_weights=None): @@ -50,19 +51,24 @@ def convert_numbers(list_of_strings): # ...then convert each substring into a number return [float(number_string) for number_string in all_numbers] +def read_file(file_path): + """Read a text file and return a list of strings.""" + with open(file_path, 'r') as file: + content = file.read().strip() # Read the file and remove leading/trailing whitespace + return content.split(',') if __name__ == "__main__": # numbers_strings = ["1","2","4"] # weight_strings = ["1","1","1"] weight_strings = None parser = ArgumentParser(description='weighted average of a list of values') - parser.add_argument('numbers',nargs='+') - parser.add_argument('--weights','-w', nargs='+') + parser.add_argument('numbers',help='file containing numbers') + parser.add_argument('--weights','-w', help='file containing weights') arguments = parser.parse_args() - numbers = convert_numbers(arguments.numbers) + numbers = convert_numbers(read_file(arguments.numbers)) if arguments.weights: - weights = convert_numbers(arguments.weights) + weights = convert_numbers(read_file(arguments.weights)) else: weights = None