From 3115a37c6388a048913337fad9bec88efca3b88a Mon Sep 17 00:00:00 2001 From: Chris Holdgraf Date: Tue, 26 Nov 2019 15:43:07 -0800 Subject: [PATCH 1/4] updating theme to pandas sphinx --- docs/doc-requirements.txt | 5 ++--- docs/source/_static/images/logo.png | Bin 0 -> 13493 bytes docs/source/conf.py | 11 +++------ docs/source/configuration/index.rst | 10 +++++++++ docs/source/contributing/index.rst | 12 ++++++++++ docs/source/getting-started/index.rst | 11 +++++++++ docs/source/howto/index.rst | 14 ++++++++++++ docs/source/index.rst | 31 ++++---------------------- 8 files changed, 56 insertions(+), 38 deletions(-) create mode 100644 docs/source/_static/images/logo.png create mode 100644 docs/source/configuration/index.rst create mode 100644 docs/source/contributing/index.rst create mode 100644 docs/source/getting-started/index.rst create mode 100644 docs/source/howto/index.rst diff --git a/docs/doc-requirements.txt b/docs/doc-requirements.txt index 6fbafab2..640bb9cd 100644 --- a/docs/doc-requirements.txt +++ b/docs/doc-requirements.txt @@ -1,7 +1,6 @@ -# Note that there is also a Pipfile for this project if you are updating this +# Note that there is also a Pipfile for this project if you are updating this # file do not forget to update the Pipfile accordingly sphinx>=1.4, !=1.5.4 recommonmark -alabaster -alabaster_jupyterhub sphinxcontrib-autoprogram +git+https://github.com/pandas-dev/pandas-sphinx-theme.git@master diff --git a/docs/source/_static/images/logo.png b/docs/source/_static/images/logo.png new file mode 100644 index 0000000000000000000000000000000000000000..9e03007d007cb9af935f0a5042cc448826843d44 GIT binary patch literal 13493 zcmeIZs{ zIRgyLv-#ck^EvO%KXA^AVY6q}TKnp?uIu{lI32BLq{NSiK_C$6i|49(AP{~C@c$^$ z9pJCt?G7*Ca@XUzsW%8j!*TP$d!hFj1p={vUZ^S=1bo?BB=Ipk%@IT`_eVrVKEuby zKO#olQcHbZMp#zjk-earjb5R7JiQpU#Jn53{w#bw?%zn0i&8m3V< z{Tn&qIGOHaFy>rbAYv1#m+BvI8~-t<|CQgh%VOPw zN8&J7`Y;%b0H6?bXdJ#Q1Y8w`Sul9O^)W#>^UbaD|Hp4XtJ3sG=!G@el1} z;v9oryw|dOg1~@yCh~ifrm= zPZB-47-1v zzCmS-Ml#d)8g@d1TZm*;knC!2^Nlf3gy-Sj3FgIs0zM@uCMb^(g#lk8Ol>0aJ{q>j zbwATZLmt$1W|TeBDs~vk7tt3euxR#0495INSyXxxBEzk3i6{J%8DcH1#a^YZ)BoRx zefy(Z>1AREJTe(C#RXJJei{bw%yJYjkLlq@ZLEPz zn%7>H&YY4JYUOy`2l>Z=nxrOf0p1b3{z11NnbyG*A=Au%e`TdBf`W5M-f||A{F= zRRH)B;&3l)yrjWiyj13k1>f$v)yW%HCtj-Qzxg$>Gh84x| z$VXUJ!R2gK(Xq34L_zsa?{pqTKx4h+cm!J+NPrbU@%l4e2llf`^o!qyr~PInAx@u% zwKAhSY4ORz4Bc_LJbrCz_Rq*l2s)i^JZ{ZnAB4zz`NS3-JvKHmQAd;^VRZw<+1tQ$qo`+CwH`#IX(b*drs z79cB3ygF)pBaq8?^V1o#3T{Co?cgd^dWTjI*%n0Ay~fphy7@%kYF!vjUA zv0;3JF5F772v`2yhlN^s1=bbXy1wQljCspnqZCm|x0d_TaVmwqWTx`8=%)0&OJ*2uNz^?jir){p(=uFlRa$s>m%XqcfKDjEDJWol6IXOf zr)-6wKU}pHJ;@1WAJ}+V^&B2Mx+Qj7hb3@*D$=9ED2{bKEfYrwQi}6IjUTp&T=%Xd z(*~lxD6o@-*-9))ybdwbJ1j^nZ3I`724!;IWy$Eb3#k4>5`7M_?u(x`iMOHz5#)1) z=V_VG%DCq@^mX%ryx=Ujo$`)2ts(d426yQyXqFE?b4>>SIk|*Ut88y2HnOAeO3Hlc zE>5Uh_oAyN<3hEfW9uQIuU@@!Ic&uTbx<3kY#BCBKz+x!BhAjA{~Bn2Xpn>*R^geP z@9!8KV+HvW1icX|{Hh=%;2m=!Swrg8fzt!()xwRsXZTq!pYY~tau8JZ+X-XaTrrb) zVR`Wam~F}5TO6;W8^t**?|d~%IEZ@oJGUi*6@`cS#fLd$W<>vS^%17kj_d}O2}sz| zt?ND}rd^pP0)@o?0mGP3K|ok1JhJ87f^pD%N?Ma~5f}LtK^gUWEMzD~2*@Xm4IZ&sd8ZCAg ze>w8FcXXov&fZW!9Tg9`?U_+opqW{Cxq^o0TUp^C%PloPvs1iy&i%fOrc|Vo(3ZOs=93Z!v$o* z68wU3QT0zqO}2dNr_JTI$Od`zdneF@3+QOXA>Zhi7h;Wd#sF?Qe$dL@J|q`Yk2@%y z^WE9rFY31C9KRl{Dy%hRr@(>=^40ERL7<=q=LqCu)W!hsHY`WRsrRhW>9S#ZJHo#~ z|1ZS0 zgh9E-4g2O?NtRZ#IUT>u6_S(MykB7bLOmVf5kc^Tx2QG4@;9gFbcF2>$BW2_f^uN0 zugF~srjU7zs2O%b@{xoN=kEjmoIiI2#GQ$eg*67R44M(Gvm&q{$8tQnbvIfw1aw=7 zXIu8oMX-X)VGf?jUYyE-%1Lto?W9xXl{8*^JW-IQc z{dk}NM^=l!ulV&ldx0k}T5_l7!1|R*uT}Z)s~QcgH!p8P+VRHUxr(L*l>&aV4G(h# znZU0r-VY7?P(ZLXm_vzIp>-MNj=wG+zh`@ZwR`7&^gB*;XQ0^!a$&~9EMKF5s!qB^ zxYffse3djXFt~kIwV*QJ2pe6__TNQW4^CIMuIrUvPTiWg9-c44(*fd*Tv)Fg_RG%w zrwkb9ysN0Hdd!9KcD(g!%{RhV%o#k)1ySub6ziK9dD!8`+8tXG_k+oa2`aN~Qlawt zo?h+f`qjVT^rMAJFl&^2-G{Vtx9#2zWd?-?84-$(X;S$mK~r73IkcXHuxC?@s(Ia$ z&hwnxjAzu-I(}|J!L-eC!%cNarFLXioGOa`Y|h)jx@Lq$0cDs(_kz<~l~Wb5BR%_r ze+rRr!49s!*wPMBU37q-gr*@c`nT{<Oufur^^`m__>ip(td76LZ+Vr*}?9S`y_flpnc4a?{%o5-)4(<0JRzUV?gIQ}D zGm_qCYd{5IpQBHFXjM=yja#lymr&r=omX)Rm1suMy7R<0*WdklWeFNsW3}TKx;Zx^ zZl6AJGZ6f>?4uA!`upcX`cry|QEz?PH-hDw@4z2Z_G#OVH*cTg174(j5uB1KK`SkE zpHh8`H~OsY^#Q~WpFCtcdRLgu?3Jp%T{5FokmRde$#2-cP=xKAoCAL>4E#0~LouWudBO~-uUikI3m3MH6huA+-S3ZCgk#c51E-y&gn z2^F}>*8$I;0xPu7)i-A@TOt#p8ZPIYJ3BG#a9hOrcO_xK+ zB5%{>(8D=}tE1}?TK1Yd)uZdAFADE<-|5eG$ zG{nsq&J*&Sr3YH9CW{PSZ5PV6qJ3VaX0gxO?egO%DL)OoD)gthVXXDiQ{_CJmwU}G zbq*j6_;+uV|Awta^Gwnfv9>q)$Kq+0v>M{laazl@TFuy@_^jg=jYVvy!|tnW!%%Ae zX4__(v*!doiMYWTk(n6e#o|>3;RSQC26>owRclur!M(UgVMYs7Rt;l=N)m?3KT56J zK12m3Q-{tzIqdJ{Lpdfk&vTrulFzxNeJZ=#hTTqHCVC9x#>$OzTnd=-ANtp|=!t@P zAxAaJ>>8^N+`kQiYBW~P%@_EdtVmc_*BIDyFi0%$QW(kc}D#%(C~Woy@|h7W6GF(iK;kVB})d9J$Q zG?^YSUQ&Ply=ep)Z1ne$_w+}2Pf(Xy{DXw%(d_;8b5eVr-GD1b6s+3dQ{vB^u5wbA z*h?iE@rARqACZNLtJj`b^ai2@dOrr*r&FZzr!nfWb!ew9*Zk_Utps!E{v|ZGl;t0k z@8^ZOz1r=+<=Gkuw1P#u%N1XvG;!&roG*)#mvU*pat2@6G6OqyXBeA=j0>hqVcc&8s>HB1?wmjC!A-7in)apgPx2m7US&-l0G8Dc`d5BeKtvq0h zg4p@mlnmUReQKL+^>MT3xbM+=6x(yvxJ7!?m~18ml{gX^S2vZs)TVtU0k+s~x$nXm z9`@B!c?JNNQYUvkUEmP`aQ*vc))GsuwoBBt+pC&yMkn(u#+Wf$2@Jh32c*%~8EOAf zkenq?#+p6DoH7~NyFk^;-@3VIv4+?>}QjJCYBiI?<9BB^MoEtaQjm|9tW zd~#zR;;GF}&WIFbTIuXnX)Tp;JE@pj{9ZvLFn>z6;U#Aar%`6SvKL7qmE;I!0%@&Jj9N$fVp6!1_&nbMJ zwt^;JBNec6a+esI3ciFSlQ{rG=2M6qjN?KM2g_-h>R*a{P%)>-!bTt799J! z$sO%hF}&QBe0HKB4#ViT=hX?B2v2tQa##g8q#QE^hVkHnd2@KGzF&P5D6-JjS}C?2 z^wy62p6Yn$-O7Dv;itkIg1+#@EIyCTXEjYJrzN>#&^HXJSnk%nz>4&D(@0CkbaI^y zG?SjygzfLt(@rmXyC=j+E~t#1ZiF<=hB?$A+JLd zgn8PC>{c9ZRaKQmk|-z7dgL`6tE007=FI)2_DoJ7|Gpp`c?=gY^@Jsh%nlSPJbsDU z%SyJc6p4{rN}ph<8uW7A>gPZmuBsq_EI&j0r{ta1C3)j~bqi=Kl5~A8fr)on*@R)A zH7ZJm>WyG>9+few@}!zmWOxsd>Ctj=)yw(#< zP2Z{b#UZpicsmm!>3h9uzI8~duuT%Ra4WN;F5e#k-%gPK_r|hxa(!*GS+}dz9cAPa z^Gy3Y>{LQm8=_{HR1qdCL1jahG?{G$RSdQBQ+XIN%)5hHdo*jpdrnp5B~a5#AXi?m zE8J!@0tq3uH!=v!DentcPnmA->D6HbqC)AWHO_@>Nm$`vw{?v*XW%+~HS&aPP-kIWo>vOykMO?L!5ov5ggz)+H%dt3|fEe!?7+>|A2b zJ!)vk?AG)&O<y9O1zWo#hW-4KFA;)Nn}yBFLx+HvdCAevZ`z&sMKT+mDwq^D6xu{Gq zf6hQE4aUGj$)U2f*BjfES(^$5wd_r1)K7Mt_vCf|vbU2A^P;<*5mp6h9({C2vn z8Vx>Zw|sSSg!QF4S6zV{{E9f_*>Sg(zcx9ejNg}NL&H)1WQj2-^L}BO0;KjE{s49+ zyY99BExBXVlZuH1N;qx}f5f%wS{-U(vSHa&oO+A9N_u~pjVxX*-)Ni_!;zq|b!@v9 z81}S24lLQq^p}(k8#TI_FX!J?h3HlLd;rH4w5!oy4z4ASmciuJui zq1YCqx-96-5p5VM6gTK^G`^tCH&K8vMq`XPc^92|tyWR46A|i#R;C=HGb7&INV6d{WD`we+?QxsMU}0Acpmu5xH&?gy+e{J^qXM(GQj(tJi|`Kb4sq>a?%Z)SdfEJ$#MP@QpBpmP zJo;hY;KM_?qwWKj-a+%hjWuDBw)>Ew$h%5cNu60uVogy9d*ymQohUI=^M*$wXo*kw zG4gsQ+-7_aHr71I`-k&0jmpSAr?dEFq>|QFQmEy@6roHYEB}2*fQav6F$W||!7tAO zmKy@H1lqjy(_9(8JApmg{RPxhnGQ*ygDBP=;n?DwJid#@FIy-_nRK zlj5)@H}Nbz*aW7PpFSR|xTQ~-z|_Ik9J4w>R#BIk{?lMZb~<3!N&V)D5qUE}6UdDa z!YMqNCz9^y8Gj4mYK0LFK5Y$F%RO%1wp>@EpF6}lqkcW!w_eXx=l7s-6caMh&y+Bn zAXR(b?OUTg3J$k2$s4if;0mJum#DMFyXD3qf7bpRaP}(!1I_PLUnYqyg+kqbtYe&e zY{-pab)N2UlAa7iaf^iD^hvh7ukfoZS*H>7$$fr?rUrND;-L^KiD}{T>^!t-x&|bQ zUXr^)JsDh5+kdz|jfBL$Df4Z1NWI037FGT}OR7ZmD#C?zBw9;!qycI>_iBcQw0^PJ zr}C8gL~4TDf)iebcW!1coaL&!y{*qB$>8()$lLr^L3@k=z9!}0=DNrG&GjE*AUOxL z$g?&U+1oemx+D$6xbwxU-0#$$*Sk4`Tl702&v7Sfd86eQWp{vNz9130wQz6rD7T$q zIDMgd$miN>=NL}*&vHFiF+^_vp{RLNmt5S!w?4T9qYcL-M)_Tg3F}ioQnhM{CZ!I@ zpz?c-V8G16-OBBeBb&bU`8GN7Je?@u{Db)VXuTeNy!5_X?y(GE)$uZ$(ylZ+Neg)M zvZq;2kZ8I~dl!CL!-u*_yDK~P%?1R_wep%T6GT@&%ubBHGLUMiQY8_5Pp1GuUAG3t z(d6QgZ}5mR-mic%!Pp;4%OYn2N5|gUuS4SK?jK_?m?q9q=j7M>IqOKNI`^tI+sMx6 zoQ$-Gh42kwCJ6=KWB#G1 zX44%ZsBB!fVI0kVPU}X}hR?x8p6M`7WZpLdO5EI=67g;F7wHlp@w?6b_rJ z{OvH+{hfE;aOsl;WnSOjQtTWx`i1MKwz~v=WDG=)%j9LKp!~1YWKU9mHS^zd@qyxjW9o<(rjz`d_a2)=(~-e!~Ac%5&jEHUeLVRo5c1wBKuNc+ce%0JHCYrECoX8 zf4g;wg>8sl0{!0Md@yU+TOXMrbAo*B(2t)^)0=bOx~p6GTdCY^?1yw|Ec^bB0z{th z!Qtt>pbp^Jn}2*CyCizKx{}21v(-l#h|bwNiEt0izCJmdKWY&O2N!IVEnmHJjiV9x zzS{t*TWZZ@7J#&~qVIW;=g-Q@!`evD@}E!dr+>n;;V^%`!mty>Q&|?cxEK$ZpE*X6t@Dq4lUL!d z(zg=FSHO87WDJ*n(!X@HYkwFs`>W zvV+uf>s+7jP+1G=@?ZoY(--xi=X2qFU8)T?wa5jHs}YA;)6bf0B*$oLUw89Dx1(5c zGL%}X&dhcE5A4H&W*=NvFP^ERgmQAj&?p;*KtJ9|dE)Bb-TZg&3%|-&UDK|TqfN1} z)zj(aCQH)UxIF!bA-=w3tLKf}(d}G&uvWblp`e4-e^NB)FSEXfzPxQfR>StQ#3Dm1 zq+Ts*VU(@pJmjt;Tt$C#BPt-f!AB(>dObB?vA-9JJ%&5O90Cz~Jsf5jX7YM3&kZbC z;tFyuRk67#)dh=%%eM9V^pf4*u-wIGR~^uZvVQ6Ico}XdykH{MvQ1s!4ZCAX`5lAH zWBL^}0=*V5JyWMMdRET(y!3PJrnM5X03FPcGx;y=y5|6;oI^LwC19C3|GG`A~8f;)Oe8Wnob6cVCy#jt`iS4~okvgT*^X>_}dIc?y znP4lg#CmZ}-+0w~^T**HjMymHh%&z4I@vKNhI;%ogd8Try04Iy(x4uxQ0T%?3xqxf?UxT)eLei=-R<&|8y&Mv zCDPIt+A`Ba4>f(>y&zgc{3+D^LgOr+?pQrn@G2DCdLDWq?kbzC-2fE#w$?_PpuM3y z%rcSMZQT5NCLCLw%gCr$aEuzUw`JRrudg#+rGi!7Hf6Ryt+Z!H`8`a?%1E)W1#x-DqSw~als+>$83v3=ma$=m@6rqIYz$PJVp<(#y=;2d@keEpEI~!qrISL zbx{f7rasas$%^sWYj9jcPBuD<$X7AX*F99R4M~2Yn#?6H3r`L4Ig9^j4E?oD5ksUOO_bE@zZ-zqhxA@CDs4%8J}@P zua4!?hL7hj{WWU!O(6>U_#~;grA4}hEtr4OQaZcE>pQi_l*{=cw#oFkQaDG`;R_Dw zBfv=BGiBANxD7$?UMQMV*hE9g?Y+tC*@mBV4^af$B>iElcG&(5Qt0s|m>n#LQP9O# zZWs?E4z_9E!S5wYmWc%#x1AhLC&KjdU^ES7lJbFWVz(TXjf{auG^^F@7t?3QS6u3Q zkeM%cI(UcL`^@VOlNd8BysGUHB4Z?CaM=Ex3QmF0{5$AQPeHT!vJTI>z$r}In=-Fc zq!@0NXS?+EzL2Q7iQd}*ndGr8g|?T4g@qHALQNT>cYhb}t5+ZK?Yu5%WDI8WO9;5` zjGOePC*|eO5f9p1{VOoinF05>GNyYn*P74Vu`>yM!M6FVKA_3!Q4h>!dT@+J-CZBZ z9YJ%f!Jfw7ubF-qyssyQ1tx7?KFn31*@Kwq!CoNLf+FvJA1ZsIWRMii@a%>fz!DKzg!m^`=i9b?t#j{kAJ!`{Z)&os=vw6=`K36q}-xn zVugbO?FRoN&R5-CT153Omrq;P+_sr%b`TxVL(uT8y{?C%$Ry}KhWQ}Hy0KEJUjE?4^Yy4ALdBN~SRD^ONCE=g3Z!v68c_j)Mo%LVZyZ;yr&YTk&y4#DYFYFk7 zdjdN$;|ArZV*I#>Js2ybNJAC|Yq@a=i*j;x2d}N3d&s=hw7F)+)&8?wg9KuIi=#d# z9uqgydN>-26}p3Mpl_8_f0bcF`*bI9(Szr-wSL<_T%KWDEc?YWWH;h+Jzkc z0=%CsWdhYYcRmZnBrOKWoW5spy=eL{&iNzIJVE^ZJpfU3xZV_2OBAXdztmCH&jiPF zhR*Md;rE@NDE~DB1qFO`&EK3i3hD8NXSch=EXv9Y5V?v)x}J&Xb{?bcj!Dbr&FY#X zevB6zBxCxY=kft7&Un>(KLZeDl$6)kB$SqH&^EAEluDXqfN-~ryGQ;TroauGp>yv& zNs7u=q^22smET`LpDbP7$Q$&+dYTMYH~6g8Pddc1<5Qlj`nM&+**n4q3rm;mi2*<# zU2fA+V3`+yebEsDcqlIABmjw6F?Zw%T0ak6sNM8wG7y{?TB)w0JMLr>w}rEjZ)-nvmPyFdQGPR_ZclwxJq)K0~Z{zQcviML~DV?tu6-IJR+bN zKBL{a^Hj{@f3nvj3(>-7&Irg7hulw;3YERGhcnHcUtiv8hbtw-I4$y}jF5g{yNJ-%_SN)RKmje z+=9shHGp9ODYBD>6coe7Pd3~q#a*Y~@}qoDPJ;8GOPD;vEE+N!S@^J17R^347ON1l z=+!sXR1<)m_>m6txsa7FW3|ccaA@dMmALv~`bh?wE5Mr0r~imhd|XoLwml7 zw}$D3IE?E+X8`}6-g5vj>2f=BQD8w40cbl`Fb!xGyjALbc6p|6YRY}J(Jgl}Ftt2h z;UC&H%411pQ6tPx9&!xswKoHt@CyA_b6xktsza0#n&Q&&_zT=r6G3+Ee}v zJ0an8r)qOwm*|K>OYQH|V*)Mggl!ck6|!v^!=YExSI~ccf7|rTt6d05BmlW}#u>O* zy)^>o`KUDfDMiEIzb!0h?D&<*7|di9(l^ns(YjTx(bm`S!q!4HOS9Z3DH~`E4JS2+ zB`x~MC}3W4sVTjk7V0FBSYRr(F;W*2tgnv zF9xhnK|3=!t(GpNEdwmwL1SUU|9JGrJ>5Z#wk<%k2Wf-e$4&mpF}@Y?Pmg8g_gB2D zJ=Rz$0qK8xeuH3FOtBzT0C3#U4~o<{VN zNCfmI4lue)Uq}JaUGs9l|HI-H!}A0dQ!I=0aM}`O*F0uky^ zMBa40s+SlQklY-I8R;U~sRzsRx`i)$@T06(ZUC&2?5O`3Fp}X0RS1*A?~zX)Vdd}3 z_|K%K1z0=8kQHCmj!y_pUNnCpP#`CfNCzN>0KMk3kuTxi6{nQu(3=QuDGT(nmV`J!7yw# zQAGqfc0E`*>U^GcTLA{DZRgLvWzqyt2WsaHKz;KjQJey1Aism^-VRDUSX4DAI#MJH zmc`1fb~D}zU#_NCC??%$F=^`RZb@=!0j7caRM{}wzwuN4YHi{U|5=sckKAlM=L|z@ z<1{)HqgtFKx+d-~xC_1HO35XHE&sF4FcvkQ|7Q~M>)_i}Z_Onh6vAPxC0 zzWd0G)o%2`kLk3PX($jff#EC~@zR)W)v9@C$~MV+?R`_, :maxdepth: 2 :caption: Getting started with repo2docker - install - usage - faq - -.. toctree:: - :maxdepth: 2 - :caption: How-To guides - - howto/user_interface - howto/languages - howto/export_environment - howto/lab_workspaces - howto/jupyterhub_images - howto/deploy - -.. toctree:: - :maxdepth: 2 - :caption: Complete list of configuration files - - config_files - specification + getting-started/index + howto/index + configuration/index .. toctree:: :maxdepth: 2 :caption: Contribute to repo2docker - contributing/contributing - contributing/roadmap - architecture - design - contributing/tasks - contributing/buildpack + contributing/index .. toctree:: :maxdepth: 2 From 4045cabb730b39ef004e450835e012f41acf2f3a Mon Sep 17 00:00:00 2001 From: Chris Holdgraf Date: Wed, 27 Nov 2019 09:49:46 -0800 Subject: [PATCH 2/4] howto index explanation --- docs/source/howto/index.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/source/howto/index.rst b/docs/source/howto/index.rst index fc660d0f..2b4856ec 100644 --- a/docs/source/howto/index.rst +++ b/docs/source/howto/index.rst @@ -2,6 +2,8 @@ How-to Guides ============= +Short, actionable guides that cover specific topics with repo2docker. + .. toctree:: :maxdepth: 2 :caption: How-To guides From af42cd0dead031d20f746fd01c2c00f3f51593b1 Mon Sep 17 00:00:00 2001 From: Chris Holdgraf Date: Wed, 27 Nov 2019 10:56:27 -0800 Subject: [PATCH 3/4] updating config files to avoid links --- docs/source/config_files.rst | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) diff --git a/docs/source/config_files.rst b/docs/source/config_files.rst index ad2a0985..26f269cb 100644 --- a/docs/source/config_files.rst +++ b/docs/source/config_files.rst @@ -17,12 +17,8 @@ GitHub contains a list of sample repositories for common configurations that ``repo2docker`` can build with various configuration files such as Python and R installation in a repository. -Below is a list of supported configuration files (roughly in the order of build priority): - -.. contents:: - :local: - :depth: 1 - +A list of supported configuration files (roughly in the order of build priority) +can be found on this page (and to the right). .. _environment.yml: From 51e26fb8a41d49364d5c0a74fd9b55e98f53b45d Mon Sep 17 00:00:00 2001 From: Chris Holdgraf Date: Wed, 27 Nov 2019 11:30:37 -0800 Subject: [PATCH 4/4] adding short explainers for index pages --- docs/source/configuration/index.rst | 3 +++ docs/source/contributing/index.rst | 5 +++++ docs/source/getting-started/index.rst | 4 +++- docs/source/howto/index.rst | 1 + 4 files changed, 12 insertions(+), 1 deletion(-) diff --git a/docs/source/configuration/index.rst b/docs/source/configuration/index.rst index e68f1409..fbd26c20 100644 --- a/docs/source/configuration/index.rst +++ b/docs/source/configuration/index.rst @@ -2,6 +2,9 @@ Configuring your repository =========================== +Information about configuring your repository to work with repo2docker, +and controlling elements of the built environment using configuration files. + .. toctree:: :maxdepth: 2 :caption: Complete list of configuration files diff --git a/docs/source/contributing/index.rst b/docs/source/contributing/index.rst index ee8ffe00..2973791b 100644 --- a/docs/source/contributing/index.rst +++ b/docs/source/contributing/index.rst @@ -2,6 +2,11 @@ Contributing ============ +The repo2docker community is welcoming of all kinds of help and +participation from others. Below are a few ways that you can get involved, +as well as resources for understanding the structure and design of the +repo2docker package. + .. toctree:: contributing diff --git a/docs/source/getting-started/index.rst b/docs/source/getting-started/index.rst index 5b46ce0a..96e5f295 100644 --- a/docs/source/getting-started/index.rst +++ b/docs/source/getting-started/index.rst @@ -2,9 +2,11 @@ Getting Started =============== +Instructions and information on how to get started with repo2docker +on your own machine. Select from the pages listed below to begin. + .. toctree:: :maxdepth: 2 - :caption: Getting started with repo2docker ../install ../usage diff --git a/docs/source/howto/index.rst b/docs/source/howto/index.rst index 2b4856ec..c7ee34a3 100644 --- a/docs/source/howto/index.rst +++ b/docs/source/howto/index.rst @@ -3,6 +3,7 @@ How-to Guides ============= Short, actionable guides that cover specific topics with repo2docker. +Select from the pages listed below to get started. .. toctree:: :maxdepth: 2