From b59772e4bb369dd8a102740eacb7ba5fc8e98ab7 Mon Sep 17 00:00:00 2001 From: AvitalFineRedis Date: Thu, 5 Aug 2021 14:51:16 +0300 Subject: [PATCH 1/3] readthedocs changes --- docs/conf.py | 5 +++++ pyproject.toml | 13 ++++++++++--- tox.ini | 6 ++++++ 3 files changed, 21 insertions(+), 3 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 9897f38..262841b 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -10,7 +10,11 @@ "sphinx.ext.todo", "sphinx.ext.intersphinx", "sphinx_rtd_theme", + 'sphinx_search.extension', # search tools + 'sphinx.ext.autodoc', ] +pygments_style = "sphinx" +autoapi_type = 'python' templates_path = ["_templates"] source_suffix = ".rst" master_doc = "index" @@ -19,6 +23,7 @@ html_use_smartypants = True html_last_updated_fmt = "%b %d, %Y" html_split_index = False +html_static_path = ['_static'] html_sidebars = { "**": ["searchbox.html", "globaltoc.html", "sourcelink.html"], } diff --git a/pyproject.toml b/pyproject.toml index 3c3b4ae..24c8f78 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -38,15 +38,22 @@ nose = "^1.3.7" ml2rt = "^0.2.0" tox = ">=3.23.1" tox-poetry = "^0.3.0" +Sphinx = "^4.1.2" +sphinx-rtd-theme = "^0.5.2" +readthedocs-sphinx-search = "^0.1.0" +sphinx-autoapi = "^1.8.3" +toml = "^0.10.2" bandit = "^1.7.0" pylint = "^2.8.2" vulture = "^2.3" scikit-image = "==0.16.2" [tool.poetry.urls] -url = "https://redisai.io" -repository = "https://github.com/RedisAI/redisai-py" - +"Project URL" = "https://redisai.io" +Repository = "https://github.com/RedisAI/redisai-py" +Documentation = "https://redisai.readhtedocs.io" +Homepage = "https://oss.redislabs.com/redisai/" +Tracker = "https://github.com/RedisAI/redisai-py/issues" [build-system] requires = ["poetry-core>=1.0.0"] diff --git a/tox.ini b/tox.ini index d74449d..3f3594e 100644 --- a/tox.ini +++ b/tox.ini @@ -20,3 +20,9 @@ commands = flake8 --show-source vulture redisai --min-confidence 80 bandit redisai/** + +[testenv:docs] +commands = + make html + cd _build/html/ + python3 -m http.server From 07f33c1e0f71f97082aadbec0415b6461142175c Mon Sep 17 00:00:00 2001 From: AvitalFineRedis Date: Thu, 5 Aug 2021 14:58:57 +0300 Subject: [PATCH 2/3] add logo --- docs/conf.py | 1 + docs/images/logo.png | Bin 0 -> 8831 bytes 2 files changed, 1 insertion(+) create mode 100644 docs/images/logo.png diff --git a/docs/conf.py b/docs/conf.py index 262841b..d098b8d 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -20,6 +20,7 @@ master_doc = "index" exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] html_theme = "sphinx_rtd_theme" +html_logo = 'images/logo.png' html_use_smartypants = True html_last_updated_fmt = "%b %d, %Y" html_split_index = False diff --git a/docs/images/logo.png b/docs/images/logo.png new file mode 100644 index 0000000000000000000000000000000000000000..f9ee8bfb4f205b2a1fd6713e616f6596d2cae30f GIT binary patch literal 8831 zcmaJ{byStnm;H!Gmw_ndw9-seSWX(;03P~kujgs-e5rvv^D-u+-K) zs#C1`t2fbR=)>+&K>L*{btsFI_hJJ;V_F}i^sN|s9hG{f?y$CA5n18 zLm!}#VPQPOcu0g-f@jD;p+-s2Bnq|taVN4l-q@^=Ng!w;kUT34E;#r)&6|$Boo_eq zdwjf&xO~4pJf(3M>!f@!x0SZjE3J=dLGDM;O&M}*%cx{d2%UXPqj!#F+#~1hmC)rO zkM|?NlD_bpk>!rmu-Z$bU$uVM_8{W(TR5w7!(+K$V+W{*BJVH3EY2)B7ANNbz0gI%+txveR@G9q2G7lq%4bDRF54XhQ65z zK?9C2ny8~D_<4J))K|`9kspqQNn|V2_>fjQ2^{S-vU7x&@Hxjd`4_HKIt;Xu7coRd zuAv%M8sVn93E{+u!@A&t1bz;2*|7v}HrcO?;-nh3qL}Yx`a6jnLn4TkBI6}_(Kk6f zh;i}ueC^>3;@}oX@I-2ie^nVO@Nk@78|lydS>NVTxRq}m-4>dP8PU6a%a%nm7pXQ_ zMg=dQD}DT}v~u2N{qAj%amnvar~HU`uot{wFX~x0agz|XBA(m{LgYgpf?a|r!anz) zMO8gXiPVQ!{_`&zyz)499=EzD)rV94-u)e{e`4EG`tZq{=`z*ehL*vewv0tj6yX*c zXtCi5jSpUjHtz{S*I}z7i<=D=HL*|1e2ZCO%^TWEtdtp@^>Z4%2Iuoo1qu{tOpAEp z6wkOv*Ebbd(3FS|@3Yy_APc)}o!qzpN1s34MWJkpRWu@hBa1a*fZnc)2?aHY(%l~{ zxnb;^>JS;1_WDl7dG^qVD1c1E)&-Hm(zRs~lUD*Oz$-rYPMK&JcgW!m(e_vQL6gtYL%ee$uiB|Vonb0>Mq3wG~QBqazY7}lrX`eL= zxA5Rd`?5k7DZ%U2WQF|D9>}5vjpKJICtCbsnTxw)%6^lb?j7W^b6X(&94vD6^6k(k z)|k+!<6HxXA-AI7`8^e~Fwggobu+&c(EF=^4U=I%bcTX@I=zP%gPig)Y@52W$CMi= z$=-3azjk>2>w&_F0ltF*LuI7HzO!XaD_X2Z?&nu|92+^_vujNLpq$8#b-v@1xfGXu zBTE9Mi5bq|{|akD7!8W!W2&`o`eMregXV=?FvmVi_3roA`xGR|-;`YoRuWS<8!TU4 zbUQ@Hl0i1pnVnvwSD?B4%}|k`Cwr%?%Sptd!qZRmV>)%!Oi&2!pEz(}t=9f)*!{td zOu_N;4^w5MkKd3SWDLcAb=(OpR0m$6Z}te0@kR%nm<%>7H1fm--=+oeLly zTh#x{QkR8k7pw2fBdIcs zQ^0CY%_RcX*6Zh2R0IcpWJqnnKPfW}Jhc*jHHb$V?!=O8Yg8eBi zb(%jVd@a@%C97~FX0JLyUlrH$a7%~5OYxqo_G+Ej4#%m&{|Sh-QjgR4{ugrQv)!G! zDGGUcaloVgl3F^4YJ~LEut$;u`Lk#E+xZ!2E_@(6<;RqVo2C7^Vo;8o9-BZAJu9vZ zQ_iw5TXgq6oAH_xrV}$!ZYYBxp{H@DI$WBkkpgn7oaVJuTYeXm`9;@={~0(32RMg# z^59{VTu$@!mq)5F@M3>yo<2AoCsuZ^utU))Nxvb@Un~^S@^fh(PfTdB-A4M|cO+}# zx_N`|WWgsKIl8wP&sS(>RJnEGy*tK-(rKSwd4NiL5ZG$hiAdm($Q?Y=WX0{Cj1o6L z*(Fyaze5Kqw?y0!GlxWRzYmiY$o1YS{74!0Iu`Uz)^A(s%?f;~aq;ZY-D?iRuZ846 z=4K3i3vo+~&QD4+Kr4RrxUs7eB*oK;WbQ-ap@M^khg95+ag7#bQigTT2&}pC}S;oc}- zLxZmL2Mn+q*%IQDV1G7kv}Y+0hlro&uxEvQTBNVhijMLOHOF6W$FmPOWdd;+XNXGk7A3TzT(P+MjB>nEAG?iybbC5HOw^`q@#GR*cVCNYEW%}G)> zOoX{hE%%bHucWlK^iI&8y#+8x9wmPJ=_;y7ihVmjEhzIj$fQ0MXX{^1x%S0U3UniV z?pLlPA~)%BIhw{4xcxH3K9Wg;M;-4=#%uftmWXEf`F3rzJJm6&0&Fdkr7%YQ?Y*U| zToK{CIiOvC;rTAX9SA{xG%#{VGZb8#IO!_Zr2QQlpZF1kH2l443_?iz`CKZqf9dos z3)16d;hOE}!=iF2$jj;$hS}Y8+{~=SN@7YI(#D%6-U?k;jZj0-(OZ)=^=$P6nhI<9 zU7O5|7BA>%JeS{KNs(da?dWLqshZ|RCeuBg6tm;cla);fXc$0v7}4lYzoZBT)iV>Z zoM}$q*2w2Uys&-9Z(u~7e!X$X{|D*v`aIxPf_0F80aEqw;~&>U$RlKfbwx#CP> zzMXqG$@$UW1I}=Jv7gV23~s=pIg-`Wev_@Oj8wz?&%S8Qa3!SmE@hc+N_)35g7pJlE$jJl6q`2I}Mvt zwhRSfR45^?1nzSil~uKUSm$Gk4cN^i-QmyGo7jgmfvN(rdqR?Ym*B)}!Xx?I0US?H znvKqYgXl<#bm&*Kr}bn6sPg0?@AtqrSQFHOG5G^b{q9#2N}TTP(_%};%1nrk1<5CV zoW#WgCkK&c2NpinM;ER>q)Wd^UTxI1@?hE#m^bBDNqjc|LFVI=bWsx~;{wK3^6ji*%=Y6- zoRiql(Li461tG1idHLWm^WMv+bM+h<3fT}eA3cZqXri#W>K+9rpgrYY-uzVqh|02+ z=VQ_|bZ$x6zNv0Z+P-jqw=?rqF+0{*Q~V&FF1a{g&3$z&(I{4MGQ{o$VnpW`)Eqcp z68)*z?iO!@6foX>o}H4H3LnNBaKF+leCeUie2L%4^7pC&?z8U{qAA1vDrEZbV_`k^ zZ@=G*ZoPw&_(u#90d|6rMTGWsy4-`DWuDj~zKYr>Q(&(*PrLs3D18(%rd1WOYa8Mc z^*c6*-I*i;*}FB1boooge8G3G`Yon0k+SVxvuJ`bi^+%gyP-X*A7FnpDy$#$q{<|i z*{}4V$f8dm(F0wMuEj7`EoID8e%W|3G{$6k{=$r`iCaJ0H=+G5C&kX&+@ly7vsGgi zTxqu`GNznmtM;TMLBw{u$>%fQd)_k|bV|2GubZ!3@R!HVAThry9P1@YtvsE9zih~U zR*g5g@bl`(Hw#1C86a*us6P@9VlQ)3r8h!dF3h5zl)ysQS`TLoXJdV{F|^e|2eNX- zt%r$5A@v6eB0$;sM8@Bgs$7n96ZNIt=1oAK8<$6vJ!VDUY~vE# zX@%*a_4|n{lt_D=ZMYiJDseNIKL;1~=cW3Vg;==&I$DDf@Yg}pDa`W6Nr6@cuO?Yo zs+RJF5~78TX^|;Dp*|$8ME3{YXWm7&K(K$lu`%U22O{reFHAD6$CMvVBm34t=6kXv z^ENz=c=+>XCh;fgZRMIbvX=etmFuxfZJ`l^Xv}$Tclod|$kHj_>LGw0rl1`r#i^YY z=cR51$F0q{agvOtuncX?I;0DcZ*HIP$H#NK<-=H1GC^`^gQBqaZ~}UvnPN%bYa}RB zFJPZJ;`&RMrRlRw0m8Zls-rzx4y%YKojENs^Sr&;n9!M;<|TmV-wQu!{)u48(qYe_ zRYv0Mm|x4|Dt)AL0JYLexkORS^S%9RBSY^Loq3ey4;G>s*^#VWwi^An;>5-H{ziL7 z62awwm)_o|`<8_RQA|zJiAKSA5IHUBCtCO&JZ(DHwj|IZ2kpokkjI{-Y|W-xu~l~= zS7AJ5qCS0lOyQ-Dy6F`1#xYIe(&$ODHg|~%P#7!SPw_@RSy1)Xz4y5#50$N;^t~Ex zOwtW}FklZh^J~_)I+pWujQ27w*O6IUGG1`|&4cmF9~T*<)2K!xok#t;KQlji$934| zap*c{_uX|rTdLlF5X4Gr>J5lPsXqUKAAkjzxM;3J01*iOp0ce_8qqVO3;3KUi;8QR zL;zBt)nvQvv0fl3Nw=4RYvTf~s;UeM;KG?V`%<_K;si83>}c{`aFr!}V)a7DhDVL^ z1;@VL9Q>fk>X{cQ6i}RU2|OJ9>mk(jt07A^SqiKH-`I@Ub6?6J&31TtEOk|A$Q&e? zDgKC8L?oZR@Ya@$Ez?psP+2UUI9e`;Uh=Nels@KYyZea`M1lth9x>PRAV09kO}@Z} z@^-|ye9qj0-~+dEZWAE^4^RW}3i4GR z8gl2^&@Aa5*>qPFsGk~Tr@{Ip6{xGB3&Ix1X}X%e+SL2+2&@B+q_k@VR`)cUSp3Jq z8*Ie~YG@E&n6-ZrsTWdLMvdkG2utyfTj=0iRs54b{A1UbdGq^gUKW*4ijV{TWf^4|k$kd!S4T6T1hg&4FL`hv>;*Q4bZVodfkKzdnTE*=au9vpPz^+;9& zI_G)iBwX%mP1#1_E(ik4)j+m7Yj|_ik8QC(_EId5KdCovjoNs;vkjQZA~qq#{!^f$ zcm&jJ8j^VpWWgFg3?A(p(qi^|dr+J<0l{=G_w=b0Lj|QbqX%(mg+wrItVl`SxaF)X zP#Vi*{l63$Br#vj0@%|O?B#o5Zyonit^bSVLNR=3YLw0U();PG;vKjth-{bP%lTNl zINn`x0e}A5QTnX-=dyj zxuiI4M;(7LeD20sukx&cLM@q+1IMp8!e8zVXflEe^7PXwVr-9XTQGsGP;h#7jeki> z+kdtDg6iZ&9BF7>5U=a3C*|n_6mldUq}Bf5Y9{1B0W3G4%NVa86)-j!G*~VX(3Cmn zI8(~<_sh;H{n*%<4m0PB<>P6Y2Lc76*dF^*Z|xIfyc1qfnW8~wy0&j+|MOodN0=6i ziY9pX*+z#VI-szUX19#Z#?I^tsc8ci!!p*eF$91@$r{m9$u&K)&fEB(B-BP$bfLUx zRrjR^xCGz^45Dk3)cSWHQAzywM+n^{2mQ((i{aifoIK3owQ21-0%|YdLRk*8S32eIl(zGa}JJKkmK;ijweUZ}>B&1!BOpno+3 zh^yYwKpxs~1-AK&LMPKoU%nlnN`Cz6{z8!5i(Pn&ncX`v%J$CDYF9BncazH1z8vt8 z#4LY*KziBWQRCVuy3;c>wy**Uujy^cvhlehh>XFV zNbv{*uU#r~k;~I&Ay+$zk5yj6GvNN@G&XJt2mQWQhdd`4N_^jP^HiTtynwq}RYr=| zefxtXn327n1etrCWJ(T{;fH$O?R9gJjMi&gkKc4?9+EX{sM zi$4;#;}p_FV{Q;S%68^RdzmK|YPOXR)>Nm`~4C8&bIbc8tse&Tk@J++Kq_o1cHZo;vmi7`;ukI|C zc}=?4`J?I_`~dpC00+ia##=B_T=J=4%kBs7IPA;t9i;>Q_Y~&jf3%pjSLie6i99Qj=HY7aUSgk7if8X zuTx+FYfItodLx@~qe*LYuJzPM=?$RA>7bFpAd8I~F4}~zwZ}bSG})mwy-O13-Q|dWuv1;hN8oMWp$oSKZ%s3UTU3^em0_OKA^+ZiGnP?*|MI z#>^SCMfNW4y{G<>v^R&lFEG@;Z%H{M0)hCP?o+S(RlH}$KL=|inASWh%3Js#eZ$AJ zW*iok8m>&OuP;3xHfn&VNf3t%jcrP#)@H9@WAD*X8&cDnL;eBeN%wv#V+{ygISRQ? z-Mt@iMiecAihUhLGsH(^ZXPwcEj8NfhLpff&M?oBIMU-*HRkRds}jL$!JVD2<(gy= z(sQShYrnIJfFWjv30)OV*M02S09V{o;->K0V6iiByt`o8KE-n+2!RTT>ksf@N4SpU zZ%Yh%4@P94=yU*%)uV9o5|w$9VM#=iRN0oUQIw)>8MtRB7wKZCR1RvfJ#F`?e9wW2 zJQA!xd33GmLgD}Jm%y))vU`J=K=I45u7?m<0cR#aRdG`GpPGZs4KL`Yq)`EY1*FOZTwpfcj8X&n1=(j#!>(8`rK>){g`fV8{^Af?*#ab3Fv zy?rVktvY=G97ZIZb@NEYx}5zE;gIOLG$xBOfH~%D&z`QUHt&-<-VEhC(@&Q({&yEo zc`^IThCVOJ@Fze+tIX(QN_tagKC=^YZWi3`RzP&*PZ$Waw!wK#Y}JGE7=nU?kAc3k z+5_s^_UJ}$xv+v8#PY^AzQl`oD`4mS`k4}F=c^|TZvsYe(Rb3dns@I!n5gx$Z4avM zLSK_K17KVu*}@D+j?dCfLd>>MXnXY1HQV0g$tUWT{0O^Kz36-@EXkWdx)j5ur^c_w zh>8O1GlI#}iHx~xpV_zl0}`^P{6V*V^i;A`CtadA6`+bJ(3zCt(LZ3Lh>&!{CH{`c zZ#$U+Gcx;f^dL(v=eE!%(MWY38-0iJb^ATKZ^Pp{`2j_EH(GYe%r%byk0B_p5($!f zFeCZoi$xws*>AHJvU1hnAPJ`PS|AiXSX3NJn)mOTq5uG;PXL@)O+H8xmhvs2LTaCB zJ71inK1=$QGMz-3`>ypq*6dL@E~w1iJ9XUxO7iBX3IE2>mb{%gpvU^7MI>jRWeW8I z%N>Iu+Z;odI8I68JX(g~R>#mT5L&+I-85p-@gIJreM|b10~t z4lQbe3p{+GS%~lLYex);dx%43lS4-BpOtBcZz|&|ehS1$b>@gIll6V+D1KNZ+IFvh z+!xqb&A{dP_Y*+ki>XL*{gFO+j9dv`4S&l3y9JCddK{*y@}lfL3~3Y2Sr&% z0CnDYbNXHbJF*nkPWl~qR6wR;LvALtlQ*-{43|CVb1N$6lY(e_as|hJOo)LbnDpqQ z*3+8KSu~)~ITo4L;bsonW2!I|DC3`7xsVs>py3Un2XQn|%0)Y8hgOJ7`guykAvGuk zXVX;dqc@-xCZFi!gU;P-Tyg05CU^&N1?+?sgyK+0EpN{9GVmJbfQ@fnf!1?H3tsXB zs7u_>Lz6~?_jOMX(_WD1nLKkurCbH}D&7!1B!wL{p$hJK4QKe02KJv)y&lG590!BnR>SW=iAR~?HOFPqiyV(9-nS7&)&gHP4 zss~=8wnVHpub!pbO0b&rtf6zfQKQ%eSiVgjhd3VOZRqpu71MTc3P7B0V{f{+a!#>C zj&`t4VD`!|C9dB(=`p0>`G63B;#pt{WO^{x=UcW3j-PBh|0_1IK)w75-}7b* z%U}Wp2Rb1bAwBD(-kfb+@h-HIK#Cj8UJS&h(W53Dd3&#Gfns+Gut}O+VXZ z_zpHI4{TI^V^tqghWkZK`K^|!>|J4_Z@SAS>|sD>_%Sd4@tXXWob9|(E44%CTXSi` zfQofoS9cT&jdXgihkQN^Zi32=)%facwQ7*ezc$;A&L31@vtUvI(;;s}LnfkO%g{Eg-^ z6r8-~y?#Gt&3AH}$rMYiK;Q>bBV8NIM1o@q#6vrbd@x+6a1rsVZO`Eh$KZe_IBlbe ziHq4+^0k^+iVb-@jQ|D4fSz>sx|1oWwB}Iusj%ih3hsIWIOZWB`Iz)kCO~j~_+v8itm7jE$G4yIj=(PfjxHy)#*Yng? z#6U; zMTz*!#Dar5o|b%+=&gdF{({E>_PBzB9n{Zh%IdL;cMB12zOyM zjPE^Pi;FrK?$}Mx{`lyWPiD)hB(|Ne&+$twO&TPsiS@fndFEa5IU-cb@c)cf^L8}J zD5q?v;o-)jejW^9#h`!agsNTJgML%LC(v3!l_asNAd7AD5x4{;Rx7_e1eyg*%H)yp ztfV2wtD?9;(Vz=di^aMCsU9fE*qf2Z2t&PbSy3#lrYSFo+J%QxkvtV&4Qw(o z&Oq%>0&R0^4TdCsb%4t20M}SAGg`pCHPZHsrk4>6LO!Smr`NawN!;O#GwfI0qqtnf z`Zx*X!OOq3y<1N{!M5{DOlZ+CLd&(?ko5oa-HZQg)cEHX6M}AUV_#M7(CNzOf-jap N%JLd=)iM?#{{{Ok Date: Mon, 9 Aug 2021 09:58:50 +0300 Subject: [PATCH 3/3] Update tox.ini --- tox.ini | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/tox.ini b/tox.ini index 3f3594e..4001f03 100644 --- a/tox.ini +++ b/tox.ini @@ -22,7 +22,4 @@ commands = bandit redisai/** [testenv:docs] -commands = - make html - cd _build/html/ - python3 -m http.server +commands = make html