From 32a387486f4132548f6836f708afd758294ae3e0 Mon Sep 17 00:00:00 2001 From: rmorshea Date: Tue, 13 Oct 2020 22:29:39 -0700 Subject: [PATCH 1/2] switch to furo, a simpler theme the theme allows us to use more top level sections --- docs/main.py | 2 +- docs/source/{exts => _exts}/async_doctest.py | 0 .../{exts => _exts}/interactive_widget.py | 0 docs/source/{exts => _exts}/widget_example.py | 3 +- .../css/fix-code-linenos.css | 0 .../css/interactive-widget.css | 0 .../custom_victory_chart.png | Bin .../primary_secondary_buttons.png | Bin .../victory_bar_default_chart.png | Bin .../branding/idom-logo-black-square.svg | 0 .../branding/idom-logo-black.png | Bin .../branding/idom-logo-black.svg | 0 .../branding/idom-logo-square.svg | 0 .../branding/idom-logo-white-square.svg | 0 docs/source/branding/idom-logo-white.png | Bin 0 -> 10950 bytes .../{content => }/branding/idom-logo.png | Bin .../{content => }/branding/idom-logo.svg | 0 docs/source/conf.py | 24 +++++---------- docs/source/content/advanced-usage/index.rst | 14 --------- docs/source/content/api-reference/index.rst | 10 ------ docs/source/content/user-guide/index.rst | 13 -------- .../advanced-usage => }/core-concepts.rst | 4 --- ...ript-modules.rst => custom-javascript.rst} | 18 ++++------- docs/source/{content => }/examples.rst | 6 +--- docs/source/examples/snake_game.py | 10 +++--- .../advanced-usage => }/extra-features.rst | 4 --- .../user-guide => }/getting-started.rst | 0 docs/source/{content => }/index.rst | 29 ++++++++++++------ .../{content/user-guide => }/installation.rst | 2 +- .../user-guide => }/life-cycle-hooks.rst | 4 --- .../{content/api-reference => }/mimetype.json | 0 .../api-reference => }/package-api.rst | 4 --- .../api-reference => }/specifications.rst | 4 --- requirements/docs.txt | 3 +- 34 files changed, 43 insertions(+), 111 deletions(-) rename docs/source/{exts => _exts}/async_doctest.py (100%) rename docs/source/{exts => _exts}/interactive_widget.py (100%) rename docs/source/{exts => _exts}/widget_example.py (97%) rename docs/source/{static => _static}/css/fix-code-linenos.css (100%) rename docs/source/{static => _static}/css/interactive-widget.css (100%) rename docs/source/{static => _static}/custom_victory_chart.png (100%) rename docs/source/{static => _static}/primary_secondary_buttons.png (100%) rename docs/source/{static => _static}/victory_bar_default_chart.png (100%) rename docs/source/{content => }/branding/idom-logo-black-square.svg (100%) rename docs/source/{content => }/branding/idom-logo-black.png (100%) rename docs/source/{content => }/branding/idom-logo-black.svg (100%) rename docs/source/{content => }/branding/idom-logo-square.svg (100%) rename docs/source/{content => }/branding/idom-logo-white-square.svg (100%) create mode 100644 docs/source/branding/idom-logo-white.png rename docs/source/{content => }/branding/idom-logo.png (100%) rename docs/source/{content => }/branding/idom-logo.svg (100%) delete mode 100644 docs/source/content/advanced-usage/index.rst delete mode 100644 docs/source/content/api-reference/index.rst delete mode 100644 docs/source/content/user-guide/index.rst rename docs/source/{content/advanced-usage => }/core-concepts.rst (99%) rename docs/source/{content/advanced-usage/javascript-modules.rst => custom-javascript.rst} (89%) rename docs/source/{content => }/examples.rst (94%) rename docs/source/{content/advanced-usage => }/extra-features.rst (98%) rename docs/source/{content/user-guide => }/getting-started.rst (100%) rename docs/source/{content => }/index.rst (80%) rename docs/source/{content/user-guide => }/installation.rst (98%) rename docs/source/{content/user-guide => }/life-cycle-hooks.rst (99%) rename docs/source/{content/api-reference => }/mimetype.json (100%) rename docs/source/{content/api-reference => }/package-api.rst (96%) rename docs/source/{content/api-reference => }/specifications.rst (99%) diff --git a/docs/main.py b/docs/main.py index 266f53456..685b64815 100644 --- a/docs/main.py +++ b/docs/main.py @@ -20,7 +20,7 @@ @app.route("/") async def forward_to_index(request): - return response.redirect("/docs/content/index.html") + return response.redirect("/docs/index.html") mount, element = multiview() diff --git a/docs/source/exts/async_doctest.py b/docs/source/_exts/async_doctest.py similarity index 100% rename from docs/source/exts/async_doctest.py rename to docs/source/_exts/async_doctest.py diff --git a/docs/source/exts/interactive_widget.py b/docs/source/_exts/interactive_widget.py similarity index 100% rename from docs/source/exts/interactive_widget.py rename to docs/source/_exts/interactive_widget.py diff --git a/docs/source/exts/widget_example.py b/docs/source/_exts/widget_example.py similarity index 97% rename from docs/source/exts/widget_example.py rename to docs/source/_exts/widget_example.py index 078671f5c..90dae1800 100644 --- a/docs/source/exts/widget_example.py +++ b/docs/source/_exts/widget_example.py @@ -1,4 +1,3 @@ -import textwrap from pathlib import Path from sphinx.application import Sphinx @@ -112,7 +111,7 @@ def _literal_include_js_lines(name, linenos): def _string_to_nested_lines(content): - return StringList(textwrap.indent(content, " ").split("\n")) + return StringList(content.split("\n")) def setup(app: Sphinx) -> None: diff --git a/docs/source/static/css/fix-code-linenos.css b/docs/source/_static/css/fix-code-linenos.css similarity index 100% rename from docs/source/static/css/fix-code-linenos.css rename to docs/source/_static/css/fix-code-linenos.css diff --git a/docs/source/static/css/interactive-widget.css b/docs/source/_static/css/interactive-widget.css similarity index 100% rename from docs/source/static/css/interactive-widget.css rename to docs/source/_static/css/interactive-widget.css diff --git a/docs/source/static/custom_victory_chart.png b/docs/source/_static/custom_victory_chart.png similarity index 100% rename from docs/source/static/custom_victory_chart.png rename to docs/source/_static/custom_victory_chart.png diff --git a/docs/source/static/primary_secondary_buttons.png b/docs/source/_static/primary_secondary_buttons.png similarity index 100% rename from docs/source/static/primary_secondary_buttons.png rename to docs/source/_static/primary_secondary_buttons.png diff --git a/docs/source/static/victory_bar_default_chart.png b/docs/source/_static/victory_bar_default_chart.png similarity index 100% rename from docs/source/static/victory_bar_default_chart.png rename to docs/source/_static/victory_bar_default_chart.png diff --git a/docs/source/content/branding/idom-logo-black-square.svg b/docs/source/branding/idom-logo-black-square.svg similarity index 100% rename from docs/source/content/branding/idom-logo-black-square.svg rename to docs/source/branding/idom-logo-black-square.svg diff --git a/docs/source/content/branding/idom-logo-black.png b/docs/source/branding/idom-logo-black.png similarity index 100% rename from docs/source/content/branding/idom-logo-black.png rename to docs/source/branding/idom-logo-black.png diff --git a/docs/source/content/branding/idom-logo-black.svg b/docs/source/branding/idom-logo-black.svg similarity index 100% rename from docs/source/content/branding/idom-logo-black.svg rename to docs/source/branding/idom-logo-black.svg diff --git a/docs/source/content/branding/idom-logo-square.svg b/docs/source/branding/idom-logo-square.svg similarity index 100% rename from docs/source/content/branding/idom-logo-square.svg rename to docs/source/branding/idom-logo-square.svg diff --git a/docs/source/content/branding/idom-logo-white-square.svg b/docs/source/branding/idom-logo-white-square.svg similarity index 100% rename from docs/source/content/branding/idom-logo-white-square.svg rename to docs/source/branding/idom-logo-white-square.svg diff --git a/docs/source/branding/idom-logo-white.png b/docs/source/branding/idom-logo-white.png new file mode 100644 index 0000000000000000000000000000000000000000..ecaf9de33c0f57e17922342f43d33cd6286ec801 GIT binary patch literal 10950 zcmeHt`#+O^{I?DWNfbi(q#}uyV-a!=o8ugsoD$lE%Bh@|oRY(m)S5FNGg~8Um@7uv0?x7Zben zc$SMR1j5C|@ZjRo#&U6q-^;GEy$b%Z|CXhhF&8@#(?tV+@!h+ABZ!OZNGs>FFH`A= z6nK$0*c@iU`-`8C_td4bni3-}F2$GT#s=_*BMak?9>eKxHkV8Mk!D@_8Sl>+9hR4@ zF;1Pwww{q!3ncgm58pg`{Ki31lh(7xL`7S<4O*qS51QE68r-NG={nPoP3kAyH;3O8 znR@a5?3cs;q?$CM5AnmCoW_H4XL4t*&TQ^k7R=wXZYk+$q`S@xX7Zi7U8-y-%Vqdf zE8p~!^R?9H6^|uPdF|6MY~PQHOW__kBq2Z$Ru!{3efz@y9^lx)i!60TYwgs*fX+VN z$4C9Vre6T(cJ{X7GotbX^a4YHjSz3JCdyVl;!Q5>dlk~ffEfH7P@>e}pSemFyEy<;g} zZ+|O%I|T-{N47TfB_1cV+P+R;&yxE(9y_1UyKhNyH+KvfAy|G~3a{m&i;aw_+agsg8pH+*GPS{SgtpJjI% z-htTenpJ;7WR&d{;PKp%gF^o0^a3yNI7EO{ovWD zuBtOm3{CXFoku?c3oruSWml_t0JvnR)9iuns^hj!TgwK7wDOg2Stw>51+MV4PQCI2 z=Aco?T{;R!Q2(>o$D8FoR}e50TWurl^t%eB0fS58(ip#NYU=yDS4;_MB`Y_ye6|>I z@REeOFVhYe4MWtu)xbk_|E!&wf!`vK0%Ue>O^p^{gz50@KX>s-7DghrIbsY+&A8|a zF8U?7-cCXn#@r;tPCwFaRDLPqco=_FJ^`VEPa=F=FpJY$Icb3`R>73bwF^3v)}8b^ zKC6?Z*RIVP^%lh0l+zv=t>1GcH{Bo7(Yv>h-&TNeZ3?y-x{I6TCJc^q+h@zxh2}@m zKj%-}GkS#!FPPaWz=%5pWY^D~ftNg~qnj?#!^?z;bj^Uup^pnBtAin?fDQSwHNbb% zsU)Uuy;}-3TN_|Qt`vxZ9itvbh=hw3o{gy^r%sSIF2Mc%d{C0$K}y^~gzyt`phna$ z&QKSpoM!8n)S8&PI}5tG? zjr!W%R#nW%NA-R+8**u~{G}s4&eV_rH+%uY;VoX7q?tAXsKb>Qx7>gPhf&jUmf#H( zKT#s0YpNo-+(SS6Rg6$Vgvvp+)H*yU7dQQ`>#h-ohLJhFC3L6Tw)2Co)PozWS7OOX zxsfo5rmD97HYc0$fsAa~p7o(xbHUX*?nu)()dstv(A5OVaQu$GVQ-t^RQcZsOwr=` z7;2sO;}+`3qJ`@YXsyw}VOm_S)mkbo`{}1Z@t z#urE>lQ#k;Y>ceKK1#fI%EN8w9N2tlKydD?fEnb9)TR{n)b&TubK66x*2h%Xe`uXv z*?R6q#&$&B6ZZbAYgyy!!cl&TJA18mFNr*PPwtj#YtwB>T(To@x=+O$iQ*s2dFw$BL^PQXwDPrIS zr}X>id+1!iUM{ybjHU}3qvA-A=SW4;F(sDcxQ0|vwVJKhrE81_Ty>F$yJ+wEyg$|HL+^cz z>_9;lxPck&f?Fge+ip?fvyzdL#-!;|o`XIKJ&SBZDC3hjY4r+QSk-S`H&H+ZL3F`cbnIP^^@j_8%$4G8Phlu{=+&c^k6=+QPXb0^O{CCwkbqbU1M0 zn(?}t$4EsAzEu5I?rNR`I%7w`u+4Ej>M6Q!S2c!ti=?a^e4@$QhsT;NblpCzDMJ>%sfz<}ZDiAGp0ob=9;p7M za{6-lz|_S}*`kp3nv=)E5fz#X`qHwqRL6*hGw`=lQIj*W>aPpkOF_at_`N|CMm+8r znXv<5=hq(BVepCI0~3%PW%o77HtS!U9n7Mcx<6FemkRg4ouNCnp>_BACivi0@`cfZ4hrEYHgJ z4ZXbAanJm#{z6y=Cdr}2xrYGUEj3uNXPAz@B2r22^+3+-RrqGZUxMVSm2PGK0Rcg}47~IZIYPMyJ{4#B{v3bLR$#;W=ne=gp=a zFO%xWuJ>D~c4I9>PcbC5UiNILH&Y^B=e6nH8qYkfE2CUg=X;enrL&iSjJheW19{GxaZ=pC%-56rjndjoY10IX@BBZ4l7o;qPaG(5b z0o1N@Pm9&MOyS3c{WY>_rXjaWCLv_1z_-Q2dNIGbZ!I*p?PmO;{Q8Gwu$?SGeL9Ey zXlUJO_&ca#z)JlMjI;NS-*QBlNd{MOtGMvFKMy;S49~-np8c>8gb;7UM@jiFYYjHJO6< zmWLa72UPFzu`krPKKO^7|JI}mG&YMNpZ90|VE`}yaq=Lu-gO+?jja?DKnVl(o;WRi z`X79f?^y*HLf>B-iptFKx|q`onnCOyBDf3!LaMuF=1%C*?U)>c@|F(M^@7tJQ2i| zH$avCtYHjoO7LurquD#VWNZ^ZzL;2#GM?_Zj>9MD)GZ4UACU(!i1y$ObQoc=?`b-Pys{;9H4QKJaQ;sBZl0UNL4=c|i#@l_Eshr8?}w zFPQzu22+-S{w(X|R*X*ZNooo*Pw<_MvbSwcEV3|Ro3C^*RTA$-4yD&(tt_difw8RC zW5RS;!rWD&!#eji*2;o9t@Y)gX3{3BYag+8MWP1IE)+Nzji=f9@u-7bqX4ayEQ3@< zQ{B~IY+9WpdlFTIhe93y& z9<&(-d66B&GRP#;wVfC)+|Z!0tyBGOfsx(o1tGxsam7<9$dT|C%ocA{`7*{p-u_f3 zAyE3P2X3ZaNO2?lM?u*lQE7~Q<~i7~_!$d=A=LO+fhkbKs3?F6ltw#cpyG!HlzNwyfJI1)A1x}-lKH`U~cKd4t+Ja1HI5LKd2A75SfwD&1han%)izB<`WknPOskhB0hIW0qIg|0(CzOr1{^*xhXdM*6zalg**fX?zjBdjcsyysJGUjXFhD9?1e*T zY#EPyQx{%v40b1(jaB^67sbjKI_yP%)+fB6B8DtL#ZcZjw~ZSlj0@Y{3y#I7ZJzA; z?@v+Cq~a|UFET8mw9LIcysNbjK;)$`Oa+M=Inf}jN6t({28Kq3th%pVK5#J=Tk=Vr zFDGW{+i}+6o5GAMB_Ak-6Bio34qjXu+&w!aY)wA+1;UQThRh_Og;p=W%c4nQGhWeBBMa%jOtpDKEoz$=X}+#0LL|{3{P^!{I~y5i zp)>W{ZwpWj|BN+mwe^{O8T`_;-}k$Y2Di=uAsUAqDk{U5)9VXmD*O3`{LKWLfXpAM zF7|#QdG5$Q z-T$dLlNTBo`q!ro%LXl zwO#)X7yXA7%>>HZux#|JHlTd{R!fh>!xG*jKV;WZcYB*-3!0o-gTKLkp6-e2ylOc_ zH-#r^?=@{2?*p_o^HMLBk6K1n%?T7>^2nmPvS86(Qu}+2APqn=Y; zb6QZ+mrYHZUX3Q%aQ?d?|5X&Jfa|a94Q!IJj+N$-aodw43t;0v9#B3*)NY;IjEX%A zRT{C;E}Kw-jFsKb^S*o_uqG#YJ12(MnbQ_5Rg67ZzhUpUZm=6WUF$eQ1M}q|)jSf~ zIJCu^8v`ZNb)!4)%(nEthffg;B4EuN+|i zS16*3-&-C@%$>JrwE3y4iVaq=wBxMoj|DSH;r-vKyRjcAeoJ9d z&!W0~O%roP-3^KE8Tu!myU?0|VEq zp@QuEBKhCd$t@*ZfMm%sbExA(sk8GzV7~+ACw~ zwohOkU-n_tr8K4UQ1=H^@yjxAyoAxvQy%H1ucC|ov=o7`)h@N#Aau*$(xxfverRLG zXv)=wb;j8yV`ahxq4n#Yy;!ZaL%635tL`21lcWn^d*(2fwRX_TIOL;|2+@Rd@PRV4 zo*Qs$D?+TKR`Q;mI30@|x(#(fWBycC2Qqos`O5kaacG;COs20Hx>f%iv|j$U_E45F zx5_IjBA{68Qj{E2r`qtBZsosFvnt1AGAL?!EV8DMmYI^~9AG=3y+K8wI2||Nc<2=k zfD#2vfW1ID-H`D50|oDaBT3(e>wnbFJ=jze|pOg*+2*0UTU18)bjU zQiARe^{w)cAAyMwX`3f|uXQ1ep?O?D8u`xwKy~3lyp8VaB@GgId9x<V(-a*Edg4Q(k6qBzjoqLk1IWS&=uGCPti!U8h|{(B+-Q8W z!e!p^LqGu7^B-mBL&ie`wVImsXZ3ZbgIv3xfYHef)Nc6v5M>!O!h`a~E{&rdb=mpm z2Z1XJMa=t~vMZj>f}qHdoG>~4%RBuoi{-~zoU}w@@?picZC>P1N;mZOnjWRZ&AoA1 z5yBahn0sI#rDKG$7~N&%D?*G&p2d1Fr7VKUwj~&AT%CH)jihVaiOuB(0$PFz#+v>? z4hxB(Bxk)OhXCro=F}mL^_2eo_?-!Uj@)bka178a*BX}MRvx13ahOA-FH6v^Z_{ei zc{#HOBN`(8UaO9kgtp5$o-M*>Ie!a3MCQM4Vu+q zT`O%z2!ZiPSPO+{VI+PiCH&*^jV5g!hKpGXrEu`@QAp$X9%R80IXk`^J2(!x3=H|2 zDtk#TrC%9T%?E29m^Ng?-O}Z~n9P=8ndhQl4|>`+?7OUb5+W@gX_A>>j?LA)Jb$`U zqA`dNHwOwO#^L=(CC0WSJ9}Mtm?I7d$Fq=yS7N|0SS}X1fwZKX)`9iE9)qf@O8^;F zSv{f5#?_r&-tlGI$%x%zMCW7g-PnNo7T4CLMDqM9+&k|>$mb*gr^|18woKnVMWtJlZj}FiU%VUpGkk>l)m#p5 z9Tai1eaYU4nidC@Jpt>o0pk0@$}GsxAEOx0IlF*Z&nl zX@a~ofg`fBv%A4&EQyAR_1@iB1lju^sFFqd+V4fYt6n%C-P2FveH^;aD%o>{{PmD9 zP!e(Vn|H=R!jU(i`n>VEPXA__b{#uG@1%^%c<1E3uyNf|W9M%mbPnM~i~A{4?XfzR z1eO5YDUdT{ajH#mIzOyFK={JHObwQSKR6GbPi-*r7_iiZ=}Zv_GR5=ACMV2~m*eZyY$eF~SftQ^O-_&>uWmCZz2b)` zLZ}9pSANBwB6!)y$eP#MO|$7KgpiSDtC>hpra-_A4v2NL5r(wl)P{G)1$IBH~@ zkB_c9@l#fP!#H4<3n?69Itu((1t#_1B_6*;jfpiD| zGT%qPXta(`!cI)fU_(h)!xNeb$J!sH{z{f423>Do`|#1QSLrJyYr{;C{xfN;iyQB% zly}OLX{ZMrCX{vtR{zX94M*cX$uEzN@d5#vz3)vt23C8#PhQvwHT9?LP7eOH4yu{H zxGW^;X^5wZbAWrBd9|nigd?hO9IaI8$j(IfZJifPM4GgD;CQJijMw>yI~iO4i}A>s zFJ5wx?l?(eJQ$UGAT%i}*eq_-J;f@d%7BgXi%+St9wQp3fSDl7r+7&sx5#j$7~VCx zO0{k+u63$UCOi-hs`#a&s@mgpZh$aEMeaoP! zEk6Z^l}`OORW4$-QQ*mATLn|PiHRJa_CD)W*GG-4YS}Ej2JH%2Ky1I2+UCtvSALA! zV9LfUInlmtRgY!lD}lTt@n>y-3EC?g*XzdAPYGY8#ZSs`f=JKh!`e-AK#qW1O01cZ zRTrj%O8pmJdOJKU1F7kaqq=v52PnNuVAWLTqs!rI!2M65x^f&Y^zI8Ae|8<>SGy30 z_sM;Lbbz>~ay-IxU0~1wl+<&cTc2OI+*vA2myMO4-gv2ZS8>3Q7}0cb`*xhwf47Zs z+i!JrwNOr?MkQVMLwKP&ngOaHk$~P7${Ey% zxp9bA5z!mkdl5wU+s{}%IgHV3W6(r5vOvR4?+1EZPn08X3{ZfduG_pCrT;^6@q^NK z$J@Mg4AOI8pcX9AOO<9hXjS|SIC9D1eb;;EX5&GQuq4pPo^D>VkJ@lg=iWSeBW4Ct zmT)1OXub@<3IS=ZXKpbGV`+JhFqPHeRr93X*v0xkt3P>jogidVvivgUO$l;46GsSI z_S=n>M3B6pQ)8nbCe$9N=kTJKs_>eO=g3mnLRVPD)48J6Y(p7BL0yjV|HvK5&Bk8I z>fzOZJ3)OohUk7Wmu(|Zy2!#rrn#v|0Jo$pvH~08=3E|V=7^)150*jxdgICu=)WuE z@FrT#m1A3-pqjMb*oKmHaTFn-=$mFzO|CGoU4YLisB-{i(Tt!{I$FSgh>Z5nM(<&iqu_jb-Usf#4|CBC3y`4Ta7m<3a-_ z;?aHQ90bO<_Ti=Lf7!7v8NKO|puS`Xt>na`RkK=?1JC(u3Io7_H$74s@MG!E=OQ(! zYQx6DzyU*;Lg0Yv5Z$`17%|;0^ysdhUsckv?T*8Dw9x}=qJ*@yb|J@Om!j-11N&@@ zLf&dcLvSf`Q~P_)aiN$N6$0#h>vcC_kMk-?*!FdbpZ!5-pzuKO(Sfy0pM7-Nf@mTt zJ*)N?rGV0czuBzs;{kZul)Od!Y!|BaKj&XgGKLBr)+vP$00-q;+BJg3-QfOs*NaC> znxEPgvL1*TC`0`8QGqOE!+;hWdvQKGMrNBF5Qox$8&4tbTmz7h8NGf z?8eH3v-NqiZ0NV4Gqu}qOYylK`aa;|8(i3aw}4Unmfg2`qbRQ@sM;G+`X?+~*VMW3 zMuqtCuXfUG`DJ_^I8wjs1LXLV5!b0-=TQ>Cqd+(kPeOmu$BO`-ww(l4ss)`VVAn%Y z7;u`0NS_GN2H}|08)bx4gB`o1dlj7GPny3Eqv_B6E<^v8T^mh)*~qKnrQK|rsfpXj z+x22xk`6DHA0cm@Wf@S(bXBcra4nvabp(TJQYoyfk*CXLwI+VE88IEYj?E=@1aAR> za^a=_+~Z;8nB)oQmJ5Ey9-;1YTytGL#=10*=Pco*M5Bwv5G3}@CpLIs{qq_C@Qt%tcC%8~?+i{%+aMjVG`7*7^ulKiX)gn>2 zpoD(@ECIQRzqlgAod3=VW08BS!=EfaQl5coA;C$1H#R!Vvv0H6n^U;bT*HpAvHUR7 zjnbshi#QjO2{ducMtjj1YTfUP5JpA(N8w@7m!}z*bXC_VBiDt&WFO_ogG+0K{VY5NuEr2>3KqeF}1rFw2u4omu&WDf;>m#~keqQ|a z_>y&a#a~T!K0A7I@KLW3h}<7q#1zV#5{27{VbIfN_Z3(M>>UFAiuK1|sj@#|t!tSG z7|F=rh}tT@ED35%xdApae7fXkrAGb+)Tc;6DT|Kbx4>6b@==Y2{^PZ%bSeF2ik}=_ zK~a+|tg)b2$ee9}kB*XJ9UKE-X^+~o#YDJjrZ@tJq^q}*%LL?F7J zcW05*EQ^7)Zh2w4?C*QC5b}9pU@9cb@fqU!y6pMKS&2fTJTKts z3z3zNdV_a#*!lWReo8$*M264ky}At**p(J2j^aR3_G-A`)EzmzM!-2~v(l_IE{%nH zIB3z-^C1CxQbuz44wKv3PdLb~8`a<9_0~CHeaC3-MBT!1K4AaSn@^%GpbIA}(cliI z#p~f9h*1lzmudfC(+-0DhL0F%X?g&>R2SURwR&rd41{yc#z}pyt(4|o{%2x*sFA?Z zIEGi0gF?s@@7{Q{D%Ac=;7eiQ{-t_>1{X){(t5y~F8O7g77?EFbZ(Vf&syo`1tpFC znlpoppWmr6m?m&0rC$3vreg>Q7re5KVlT@OX_T`&%gvM^frOV^ys7=cP{N#xC0MKn z%tFdXweQLHfK>w8y7uT2E{#8AKQS}#9Ql1jf(2+>Db2(}L)ea#lORwwuJ+4|WpG+U zS^|s%g>$y#sEmh=Eo<#23AhdSZ{WOOqDP#0S2{>5pbQ#AF{$)mV@|^p7(xCnyLMd& z2R>Yq;swb>6voZ*6_otGc^8zMHh!_fF(Q&SGQ;gzB=_x%8&VG6n=%v}r$p^Tj7OyH zXyu6KerK1TPwV#804I?beZb1OrcA^g@XUbR*ib>dmQs5rZnocz-Kl@)6IC0R zdY&FK>9G&+l26Ee<#efRz&LS&4Yut(H%VY`g$*dW3<6|hi}z=-B;GZ4uKF4H3^lH& zd8aG1WRA5YfOnmGnE0To=e_zGB{DgR z4wuq2qSuHG!U^J9@DNP18{0hQc`nlMkDLHBlY&UAp`wU8K2Fkf`DG#)GB;+C_m8Wg z4iHa|+8}I`&rEDqduj&^tS!XfCnX?<-s_oEnU{=0q_3cuJs*0Pg~H1_c(+wc)BH0Y z>VC#HfoU51?4(ANZ~9|Y9%g1E$DxX`rTKF3MQ^p3sG65{_y7~WNpjGD)=yKp?-u{T zrpZ#DGYWnZdlNa)ljqYx*~clG0#`Ll{%BS4&}{?Gk>$X-DK1yctDp5}vwg2_lMOCE z(TbqGbufv0>n%KoFKq=w=e#aZnh6J|UqdgZ|8dkyOG2LE)_Yh3Vk7KFLwJH$=?c})!2Y$8G_wb-24>>&<8^6C@>U%edd9U*5c*m zn49%A)3U)mrHe!Kj+$tL$HD`MLDi5$57jn#7tXfDa<1Bc(eKfRX9fQ%rl6RY2C z-~E2sVN}C^VJ+(^YibewQ#N?x97gT0wcAmT5t^0dk)M)Z-XUWN>!mW0<6@BRV_B$9 zykKs0#s{^(!$nqVmA2l0_5OUm&lCNV%HvdJt(JtCPQ)xS=2+i4j__^XJ~97M#`+=V z$LfA*15I1Yw{%m@aEv~h-VSqVz{|gQUzUJW_OJhSjkfP?R`oL+Yf8n94k0U8)2CrB zx_k14dD7hvc>?a(-x1i(jv3YRKcP_qP8frU<9Wf6xA)_fi>B=b0mcJ|h1DO~cPdkG zmQ*sVAoUksn-B1rJa<~IkR3MTc(|yU(q8QveraC!;!|WO=(4 zrtl26sC!?H4)OmtOmY)C8cZZ;fl1#dJg}YuQ%J6(qOhhu78`jhczqlf@X6|P*+AA? zx}raSYS-((`qNE$(HDg9>BV-ep@ttHt0Ae-%)fJ5!eGgm`lT6fI&HZ#8AN;I@Mga`VcqpjZLnz!6weZw>^Ws zwY?sAgI`>#5LJlsC5STQ3jC6~wwju@`W0n}mNo>^Ld)d5GWvgS@DIF=^m+9EzTw?Z z`__. -.. contents:: - :local: - :depth: 1 - While IDOM is a great tool for displaying HTML and responding to browser events with pure Python, there are other projects which already allow you to do this inside `Jupyter Notebooks `__ @@ -19,11 +15,7 @@ The real power of IDOM comes from its ability to seemlessly leverage the existin ecosystem of `React components `__. -So long as your library of interest is an -`ES Module `__ -you could install using -`Snowpack `__ -you can use it with IDOM +So long as your library of interest can be installed NPM_, you can use it with IDOM You can even define your own Javascript modules which use these third party Javascript packages. @@ -33,7 +25,7 @@ Installing React Components .. note:: - Be sure that you've installed `npm `__. + Be sure that you `install NPM`_ before continuing. In this example we'll be using the ubiquitous React-based UI framework `Material UI`_ which can be easily installed using the ``idom`` CLI: @@ -95,3 +87,5 @@ under construction... .. ===== .. _Material UI: https://material-ui.com/ +.. _NPM: https://www.npmjs.com +.. _install NPM: https://www.npmjs.com/get-npm diff --git a/docs/source/content/examples.rst b/docs/source/examples.rst similarity index 94% rename from docs/source/content/examples.rst rename to docs/source/examples.rst index e59cfb601..14992c802 100644 --- a/docs/source/content/examples.rst +++ b/docs/source/examples.rst @@ -1,10 +1,6 @@ Examples ======== -.. contents:: - :local: - :depth: 1 - Slideshow --------- @@ -31,7 +27,7 @@ Try typing in the text box and pressing 'Enter' 📋 The Game Snake -------------- -Click to start playing and use WASD to move 🎮 +Click to start playing and use the arrow keys to move 🎮 Slow internet may cause inconsistent frame pacing 😅 diff --git a/docs/source/examples/snake_game.py b/docs/source/examples/snake_game.py index f7739383e..bfe26ab37 100644 --- a/docs/source/examples/snake_game.py +++ b/docs/source/examples/snake_game.py @@ -34,16 +34,16 @@ def GameView(): class Direction(enum.Enum): - w = (0, -1) - a = (-1, 0) - s = (0, 1) - d = (1, 0) + ArrowUp = (0, -1) + ArrowLeft = (-1, 0) + ArrowDown = (0, 1) + ArrowRight = (1, 0) @idom.element def GameLoop(grid_size, block_scale, set_game_state): # we `use_ref` here to capture the latest direction press without any delay - direction = idom.hooks.use_ref(Direction.d.value) + direction = idom.hooks.use_ref(Direction.ArrowRight.value) snake, set_snake = idom.hooks.use_state([(grid_size // 2 - 1, grid_size // 2 - 1)]) food, set_food = use_snake_food(grid_size, snake) diff --git a/docs/source/content/advanced-usage/extra-features.rst b/docs/source/extra-features.rst similarity index 98% rename from docs/source/content/advanced-usage/extra-features.rst rename to docs/source/extra-features.rst index f67b0bde9..953f76752 100644 --- a/docs/source/content/advanced-usage/extra-features.rst +++ b/docs/source/extra-features.rst @@ -3,10 +3,6 @@ Extra Features Optionally installable features of IDOM. -.. contents:: - :local: - :depth: 1 - To install a **stable** set of features for IDOM simply run. .. code-block:: diff --git a/docs/source/content/user-guide/getting-started.rst b/docs/source/getting-started.rst similarity index 100% rename from docs/source/content/user-guide/getting-started.rst rename to docs/source/getting-started.rst diff --git a/docs/source/content/index.rst b/docs/source/index.rst similarity index 80% rename from docs/source/content/index.rst rename to docs/source/index.rst index cf1a0a354..a80c7d929 100644 --- a/docs/source/content/index.rst +++ b/docs/source/index.rst @@ -1,19 +1,28 @@ -IDOM |release| -============== - -.. image:: branding/idom-logo.png - :height: 250px +IDOM +==== Libraries for defining and controlling interactive webpages with Python 3.7 and above. .. toctree:: - :maxdepth: 1 - - user-guide/index + :hidden: + :caption: User Guide + + installation + getting-started + life-cycle-hooks + core-concepts + custom-javascript examples - advanced-usage/index - api-reference/index + +.. toctree:: + :hidden: + :caption: Reference + + GitHub + package-api + specifications + extra-features Early Days diff --git a/docs/source/content/user-guide/installation.rst b/docs/source/installation.rst similarity index 98% rename from docs/source/content/user-guide/installation.rst rename to docs/source/installation.rst index be82e4480..9acc28a58 100644 --- a/docs/source/content/user-guide/installation.rst +++ b/docs/source/installation.rst @@ -21,7 +21,7 @@ Installation idom install some-js-package - For more info see the :ref:`Javascript Modules` section. + For more info see the :ref:`Custom Javascript` section. * - Extra Features diff --git a/docs/source/content/user-guide/life-cycle-hooks.rst b/docs/source/life-cycle-hooks.rst similarity index 99% rename from docs/source/content/user-guide/life-cycle-hooks.rst rename to docs/source/life-cycle-hooks.rst index 903b91136..fa39368c1 100644 --- a/docs/source/content/user-guide/life-cycle-hooks.rst +++ b/docs/source/life-cycle-hooks.rst @@ -13,10 +13,6 @@ cases the :ref:`Basic Hooks` should be enough, however the remaining `In the future `_ they will be added, but if you have a particular need for a missing hook post an issue. -.. contents:: - :local: - :depth: 2 - Basic Hooks =========== diff --git a/docs/source/content/api-reference/mimetype.json b/docs/source/mimetype.json similarity index 100% rename from docs/source/content/api-reference/mimetype.json rename to docs/source/mimetype.json diff --git a/docs/source/content/api-reference/package-api.rst b/docs/source/package-api.rst similarity index 96% rename from docs/source/content/api-reference/package-api.rst rename to docs/source/package-api.rst index 97a30b8a5..5f8337279 100644 --- a/docs/source/content/api-reference/package-api.rst +++ b/docs/source/package-api.rst @@ -1,10 +1,6 @@ Package API =========== -.. contents:: - :local: - :depth: 1 - .. module:: idom diff --git a/docs/source/content/api-reference/specifications.rst b/docs/source/specifications.rst similarity index 99% rename from docs/source/content/api-reference/specifications.rst rename to docs/source/specifications.rst index f3d523b4a..ed71cb8a9 100644 --- a/docs/source/content/api-reference/specifications.rst +++ b/docs/source/specifications.rst @@ -10,10 +10,6 @@ created by `Nteract `_ and which was built into for VDOM is fairly well established, it should not be relied until it's been fully adopted by the aforementioned organizations. -.. contents:: - :local: - :depth: 1 - VDOM Mimetype ------------- diff --git a/requirements/docs.txt b/requirements/docs.txt index 14984aa11..75defcc41 100644 --- a/requirements/docs.txt +++ b/requirements/docs.txt @@ -1,5 +1,6 @@ sphinx ==2.2.0 sphinx-autodoc-typehints ==1.7.0 -pydata-sphinx-theme ==0.4.1 +furo ==2020.10.13b12 sphinx-panels ==0.5.0 setuptools_scm +sphinx-copybutton ==0.3.0 From 986a090786b7673276427573c855118aabf644f7 Mon Sep 17 00:00:00 2001 From: rmorshea Date: Tue, 13 Oct 2020 23:33:56 -0700 Subject: [PATCH 2/2] fix sphinx deprecation error --- docs/source/conf.py | 6 +++++- requirements/docs.txt | 2 +- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index ba317d574..d30ee0060 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -96,7 +96,11 @@ # -- sphinx.ext.autodoc -- # show base classes for autodoc -autodoc_default_flags = ["show-inheritance", "inherited-members"] +autodoc_default_options = { + "show-inheritance": True, + "inherited-members": True, + "member-order": "bysource", +} # order autodoc members by their order in the source autodoc_member_order = "bysource" diff --git a/requirements/docs.txt b/requirements/docs.txt index 75defcc41..2368cbc6d 100644 --- a/requirements/docs.txt +++ b/requirements/docs.txt @@ -1,4 +1,4 @@ -sphinx ==2.2.0 +sphinx ==3.2.1 sphinx-autodoc-typehints ==1.7.0 furo ==2020.10.13b12 sphinx-panels ==0.5.0