From e9dc18aaaf0f9b4aa2b53e192b92330bf6fd78f1 Mon Sep 17 00:00:00 2001 From: Julie Kirsch Date: Fri, 6 Sep 2024 15:54:42 +0200 Subject: [PATCH 1/4] focus on teachbooks --- .../jupyter-book-setup.md | 19 +++++++++++++++++-- 1 file changed, 17 insertions(+), 2 deletions(-) diff --git a/book/installation-and-setup/jupyter-book-setup.md b/book/installation-and-setup/jupyter-book-setup.md index b18f00a..f30e1e7 100644 --- a/book/installation-and-setup/jupyter-book-setup.md +++ b/book/installation-and-setup/jupyter-book-setup.md @@ -5,12 +5,23 @@ This page is useful for user type 5. ``` -Jupyter book is a regular Python package which converts our content into a website. It's part of all of the `requirements.txt` files for a book repository. +Jupyter book is a regular Python package which converts our content into a website. It's part of all of the `requirements.txt` files for a book repository. At TeachBooks we developed a Python package called `teachbooks` which takes over the jupyter-book features and adds [additional features](/book/features/overview.md). One of those additional features is the workflow to GitHub Pages. + +```{admonition} Note +:class: tip +Note that you should specify the package `teachbooks` in the `requirements.txt` files in your book repository. +``` + +Concretely, this means that the teachbooks package can be used to replace the jupyter-book package when calling jupyter-book features. You could think of it as `jupyter-book` being a dependency of `teachbooks`. ## Build a book As soon as you've installed your book environment with jupyter-book you can build your book locally. The official Jupyter book documentation is quite extensive. Only two notes: first navigate to the directory where your book is to leave out the `path-to-book` and use `--all` whenever building a book to make sure the table of contents fully updates: +``` +teachbooks build --all +``` +Or alternatively: ``` jupyter-book build --all ``` @@ -24,9 +35,13 @@ Once the build process is completed successfully, you will see the file location Bookmark the (local) file location for easy access! ``` -(setup-local-server)= ## View the book using a local webserver +```{admonition} Note +:class: tip +If your book consists only of markdown files the local python server is not necessary and you can just view the book locally. +``` + Some features like JupyterLite and Grasple only work when a webserver serves the HTML content for a book. Rather than building the book in your repository and updating the website on the internet, you can use a local webserver to view the book: 1. Make sure you have the TeachBooks Python package installed (e.g., `pip install teachbooks`) 2. Start a server from the command line with: `teachbooks serve` From e4002de73c47a9bd11e57cf0f16a765d1131140a Mon Sep 17 00:00:00 2001 From: Julie Kirsch Date: Fri, 6 Sep 2024 15:57:01 +0200 Subject: [PATCH 2/4] addition --- book/installation-and-setup/jupyter-book-setup.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/book/installation-and-setup/jupyter-book-setup.md b/book/installation-and-setup/jupyter-book-setup.md index f30e1e7..1c98a0b 100644 --- a/book/installation-and-setup/jupyter-book-setup.md +++ b/book/installation-and-setup/jupyter-book-setup.md @@ -34,7 +34,7 @@ Once the build process is completed successfully, you will see the file location :class: tip, dropdown Bookmark the (local) file location for easy access! ``` - +(setup-local-server)= ## View the book using a local webserver ```{admonition} Note From 8ae539413afa941581a2d4dd15f3fdc29156cd90 Mon Sep 17 00:00:00 2001 From: Julie Kirsch Date: Fri, 6 Sep 2024 16:21:06 +0200 Subject: [PATCH 3/4] update --- .../figures/Terminal.PNG | Bin 0 -> 13588 bytes .../jupyter-book-setup.md | 21 +++++++++++++----- 2 files changed, 15 insertions(+), 6 deletions(-) create mode 100644 book/installation-and-setup/figures/Terminal.PNG diff --git a/book/installation-and-setup/figures/Terminal.PNG b/book/installation-and-setup/figures/Terminal.PNG new file mode 100644 index 0000000000000000000000000000000000000000..d015e08328089143a4fda4f33490776a2b6ce478 GIT binary patch literal 13588 zcmd^mc|4T+`?pgnCDQ4H8c7=oX^625jvT2dZT4j_$CfQ7nX!yYD(fWsHj-pF_I*i= z3B#0atV71kXvAO)W^B)`zUQ}mU(fS;et$oY*Nc1cxj)x+U!Uc=-tX(W!*1U)5IS)D z03RQp(DiG7-R0xs7XZ#z1oi@dt!`D?0f*lZcMY!a757Md2QK)Xb#LnO@s(l(H|+NS z*ZUt{vq13i{r+g@_cw~uNhBZN<-F^E>E1`$&W(5bven9-d;@*_yU$fN+5)9{XSpX+ zO=#aY!;L%oB?r#G7E$P6^}Wo|xh``1{FBSSb**e~0-f^lJ<-7k?fQB4aqn+Gk9HwH z4}9`NQol~zMSdMscNFI1`}pjC_`s9hApY$wmX6Lg7w5gff_2`$s&iiN*c|8K?H5WT zv)|qxbgUq^>K^NK!M&u4b@F}G{C0%@r-NWh2#O?m&lX^2wXSKCAT94S=?`5KOB z12)?E`8Q>s>;e5-SO0oD^OFA$9++$a@lRyvR0nTyxr_|VMw_n8EO)CR9nnK);O?Nm&X2}xX`z^<+0>@)as1Tvj|bT(68CX`UVE^ z&-&eBd#@7}$ME|2rHxe*xvu5_!KsvJEXcZ^FtzNzkJ z+iDZzw+eOIe+>s%z4LU;yhDzq$aGFOd5LO=a9_pw_wGX1fBcT8cH39OxLS)MGzX*8 z7^NIt%ln=P@#iZQc>B5jv4`{$LbwXY17?N@nbeejjUb+)-1ZDoI9fz-NRp77JMYWz zDf2pqb7S{-v%)wO&r$YUN!(K;&vBkBk8^|XjF%k|=Oxn5xh&>B@(zC(lT&p6L!;Dv zxH!?^ZIy{aE_9K|G;^)*spn8k<^wjh-441r(_b97ir2%?17~SPBB^}ef-;*Hw#|(i zM4zubX6fXrXg^4cSPSgne)YzgQ_qbqwNWt^?w`b|`*y^QwZZP@DxM#S__!I6BB+{; zmAY7$&}!+28YvT%DYH?j0+xMgkA`IJf(3Fac>veHVt(>~g3JT#AA?E$JX%MlK`ufQ zLo3DTc00R65{1~O&=4DFlYfX5>AJ^3RhBw<{>@Q>##Joxg@f(VvEWCo5E3AlZ*5~q zMqnl4fSb4Lz`eH6(Iv_wcd;;RRf-^ftoZn-o%U%*@E=sMO?I1d0gMvr@W2aZoPI>b zIQ$->HAe4{oT=|_hp*#O=FgRU(`X9b&==AX-JSQwKg3aDNtk_JB84Q)sl~V$a3cKf zg`J&Hp5hc@7f+2%<;Pa_hr;xuJT9HQQ~5c}U;ttaE$7iJ&VQ&{ajZx)hns7vKqS3`|Hx85PC*zW ze-|3@c&Ee4KbR}0+6()$q7vQiIoRXr-xI5&u=K!t4qrwpr=s#}#Ya*P`+a#p?j+H< zfWDub{HGQPffE}MxG(}peU(16W2GVFrqDCTmfMNOzL=nAb~Z+rH9iblZLd7uM}9Yc zg2Y8<>zmada&3_pb(o!U)3L2Dd!dYIjn{kmQ;=w>X+x;{nT>jN(cLL?7vL$K5#FfD zy)74m_ffxgxid_Od2e1WQx-{; zv=zA8?zYLVryjTQqjScwZ*St3rT1g`cecdc2+9#e*JspM_u1dT1f*n*_fCLg$NIvO z%Jrg9Z#Fk1lR$fYGVh3XIL?`i%2eK74~iHaed8ABqUr zS{%7j-^`d;KI69lu5lTezNZFQ@Pz1_TCdEE%rTzjg?v0Tf7+<4v9PX3pBZcZh>oxM z5p4O^bKQoJHX_E6cZ$^i5~aSXEcvd{zbC+9zLY&Szg}E4490PyI6E8KM|A@FdZu}y zD}>8DjW{KC@Ow~`&@=z1ZjIzOonB&zPa_FO%5#WLPaWG>Z^Wu^AoKv+M0<$5Uk&Ab z+J=|z^AzbHFz3QdK)aaG!w5(Tz4t@Wb$DjJLlr$TvhQelNW8PUv$cno6kQF|M&FsZ zPY9Y-x+Sk5E8O~})KJ~V$-_{=y&fTxKRyv3xY?WyaCp2Thi{Niq8hL`OSaxIkIJ^Q zg*S&7f7z7awP|Ii4tbB^sW06{e!wHB0~VJ%xmlji;ubp=Ed~4QijKkUW579UBXdaj z{9;;2an;4hV>_=&m7qvn6Kti?n{4f-8I|}emapIAlbyY%ERaZZk0O$$!%AG3JtL{h zTXm(T#B#P?(Y+CP(|$brip^)d_ITF|CAV}F+o>zOzjKNf^TlHGtY-)-x$xLc%;r7O zE#@5sYf>~|>tQg%z`?V0NuCi|P$UT78U6(|0z^QR=}=bx`j+7Dq^Y*@g@uw4OR+R; zQu^i%a1I`B`8)%o(>aH^XawQ@(c>=SejgPk*b;kUKAL!8JWL1r>-V? z23&nb~GV%@_KyXuD~O>AggO?;}bo^WKSj1wtMM*@M5bvCm)^h&)aYk$zr zt}(g#T4dnfcNe(JS?PmSU2`{FCQi{AvBeT+qGiE-B@uJ2|1% zX;JnEFGI*nME-A3DNbe|QQ7u;>1RC8X0rwFfr81=ufxBEsaFi7v$07h3cbgP$DGk0 z+S6u1-HL#?CkV-MU6Dcvmo}vMSMM&`7LQEwD@3@IPM-oc>`VoT6JWotHgZ8|_sG`J zGw0Nk*$OXVz@m+QsyntCpdPmvURvxpA54O+ki&C?4di6Hh~g1%LF|udEc_Te$}PS1 z?eO4khiKXw|ISwVFz+6S|Kpiu)w2zS`t*5CE^v>JPgP(c@PoU^w6TXv2KE}KT=(bQ z-$DFHjYFIKx?Jx=+D*bc_dxCL#SBdT=HiY6A6eREA zyM=DbiELd)$Lp|i25OrU4zV)$h^(Dp^+ZtfqXy_^%4OS~{uh`-QsUpNjb7*!`K=g# zx2e;W3Jgjck}_ZBY4_req2w($Q-*&k*Kk2q;Hnx#z`=;3U-hjQz26xk;2#v+F7)ge zbq7%K;i83}9j0Ki}^ri`JP)p%nZQ6Rs)#^@?z_M zv}g9mw4bd4Ny;s*@_ZjR?DRf4&dh1U-n!ygauYkfh{cK9-?_KNIT#^T;=rC+ zakGy{we5Xs=?o9~818YFPT8yL>en2Ga1WUzB6sH2$AW-Sp=TWK{OJ|?g(KuV)S`uO z(Z5@|t4P`rHmQgNgq75cZA8|U&BT%dI^W|N zn_|OwavR))BdKWI+^>Xs3JnPPv&&e%K)&7V#)N^YKp_}4z4xi8@{ah8JzllCuSJWe z)E&PjQDj7)%`1)K;npQ`g0`~qb_1;E5DBIkS|WNF#P54?ips;upJz6?Z62r)de#qf zEZzDn^b8-f_;YtRTU`S2JC>S@wl97Wede&3ChT};Lhc9*CtB#X-g!l}Toiw^2c2DK zn2gE5Wo$Ta`&=3&R}-!!ODPPoW6UP)?I%X0a@Rd+S4O1-rly)JEINUC+_0H%0p98V zqh_s_{5fNTMM3;x$GET7>rwcoZQ4&w79gd+)-C{#Yb<%$FVaI; z);rrJ-^KQSL;L^0V$pv?`+OjNc2MxvSTQexA9m6ZRGmR$ZHOOQ+(cO|ZN!|^8hQ_I zyi9kl#72-ZUS=-V)xkI_Mc9lYWO0L}C`)4=kR@gpGWoPgTQX2@LlDIOjdYo^H5APc z;#XvLh=vy-7_Jb38&)S_-2I`-*q5+Ff5Th&c?*XXE^433x3KL8;T*%OhPO^p?^E7mi#z z724eEL=E$2))uCP%p)H&^wpP3i^d7JbZ!KUFCLKCykH3jziZ1r{z_)X=8zS2UI{U# z^%wz%I+1G*SrZDqSv2hi<{@RJO=GsVK;Sa&1Y}M)J`*X=UGwJt#!KVSldYrClh5-FV4!5GE6UyD7{p#jU_|i`E@?Sps7>{@#CyDjVB=ieX!; z3)Q!f*yFr(*oE!bhY8JL6?5U!ZT>iX3Mh+8lT~&z(gFvxe`@W+IYGJC-KJy4z?sYSI-~_!AAU{IYW)f>oI$0}Q6(Xl=@6oMoaKzO3 zf=aA8L5q;O1fCD<(WGPC8YIAmr?wlpz^W?tb`PPO4N2jJa?1v*%N)!GZ4YZBrKKQ-1xk|I$j&AkUK7ymFlMykP-Q8ZH+ zcd|I3_7S|!C z%RT!WATfE3kEmxby@Q3wvnr|vXsDyZHLi4_gtKS6KUcPAIxCm`JJTATp&l$f{@xM@ z8FjuTJ%;zBz`uF>H2l4u=`p<89n)pbF=zMIY1c42f?_!zqP_+NNt#Bs6rzuUduWZ{ zKO<)OP@f$aAZFP?A#tm-5KKD=54h$8yj5pg+IfP6Zn&<$iWj+Zu5bMs-rN#xqLT}kf z>j)D*3z>>gbH(l$2Bm_Ib9p?Qm;kGCPl|{hkyGvlPHH(VjbW8Vc>{4!_{3+eV-P` zoTYVvV@6smL@Ox%=p@6zpTZ019q|_J;Q6e=s;g}G;V4IH%J4gUEK`&u%OFQnC5$+p z>^H>G_9?h96%_GEQcqXs;``)XhT{`Szk2`t$tOW19FNp$ejk7SF8gmFI%5ac|8wCw#2jhDM9J~40ZvCl@ZXXX2de%vfVAy zXWh69Tl=dwnmE;ynmqJ(B#Nh^WLqR5X~I~zVhj=8=@oqx#D69&qGKWFYtNQ!g&{=X zIS%s_pITNk#|e55Q(iK!;L$u8hrC3rRen7HP%vlGK>Xkjv4U?6*UzPmOU-aLkBMa~ zx6fYsr80Cs5Z@zpqP6Y6`nfhgF9-2AHtEpbEsKeLZyr|t^*ZmXho#mmw*(`SmXv!& z9IiHbDlDfu#sMK4`h2~O3tshX`opUeuii) zBtZO(daTXN9aooQm{7H+XWXGk`sC!;$&nTSBa^rMi zJoyvT;DKL9_ZuM6V$~!GZ$}FTW)*u*q*EOS5Uj-9tmBGa!qh8P&={sDhraq*34GCD zqqi@52h%)(ElOud4JqEG`q{BhpWUjzSR$@aZm}?p&!}_hBMu zp@f$m@1=Mn5$SUdEOYJ<=N**2Jg#hOs)a?Pd|aZwd!jqh$Ajik^wOPCeAxIC5gh&< zOA-|K@Gjqp(q9Q;M@bB4%e7oV>6Y;BtWjL3NxLNxCF*2)tg`2Ux12?3RNI(UT*Bkk zR5gNVHg>U$xwzaF+d6*r&kvQL3@ZxgkcWr{7A3zU!J6d(5g26DM+~JF7+Hg8dyLiV z+{&&tYK@~!wi62RY0mae@r&}FkVx`Xho-8oy4DNtyPugiFG|WL%pSe_XuVS0VsZ~QG}+{8QF-~>L7w*S zY%lp6l}YD*by%UT`}X?g)*AQq=E;R0@ShmN(yLxqMD(&_rlUgLG#jhr+Je~5c3V_g zG&gA^boD7#8rjCVMyQiM5iexXWD-n7pU7pi&P3dGGm@-3KNp#3g2{nlCH$#Ib2K#& z+}0->zq0(R=es|#hYf%|GRrLN_WT1qBIIS|Q~L2%t(j;V;oFxHwmh*=>A#~7eOD$+ zb>eG?Sa#9k14hocqM2~lv!?j|F@s}S@df=(NRNzIGx48XBpJmOdgiNp?vTggDN)k* zA;ri#$En$Y)2<#c3#jAZmBNl;#ah0D9)X+FIx2}F!%akbLCdQ7 z`glQ)JICAhIJ=g|d0)KIxS9VQTs^zE(v{k}kmfEUQA*TMT(0`TtySDU@axSqaLu|4 z2lDm%GnT@Gw!3~})Jc*<$mHo@E_?ttT0d>92pFE~t%td!SMU-u|mu?{*UH3JWsTm)!oD|5c;Uuqom5&=;Cp0KjI zaKU(=-C~f#y*USZ*);L`mIz2_*A!!&A$L*!hF1NacHSbxXC}ktweM#o$B*(5k5wO`{lB1*oGzKhRz zr_R6;jlZm0UJ^HUFNgu6vnPJaRl2Xeng&=+o#drv>Zt<+P{-3$h1wGHf;$dtxlAJn zdKA=(%re_!+pL)D_1eu>OSYXU-JdrA__xNQ!KmhHmTjZ{RlE4wRl{XHP~Qc*9;zoI z^ky_0VWM%m9M;4A5vJbVoxhpArGXtBdtI1Rgt(b1XzNV4?6M-)Y|v!Ol-xf&;Add< zz0^5GYT2g0QSDJt{dg6kyeBiK=vH%~_R&nQ><1pj{p6@Rqx@ivgjJ}&M_99B(-UGpgl}@qR;WO2h zm|=fRZOw_9`o!UcFIGlXJQX?8gM%`v0?dXkH5;&T%FDZ&q=8S;E7Uay1~Eyr2yH9g*EQ)V()pQWi5{LmN^+S&wJF8<;O~cl{(10$v zL#U)S>56zYEZsDprT4ZzAX$Ij&$)7zGNbOGQTAl9Ez7lXpw51P(ih$`>ZfQNJQ~sQ zxY>zj(QN|%1|MW4k+4ar4C8DS$XR8&zkP*xH>}%#`?IymdUl&ttLtjw_^mKF=zNB6$y?ve5+g%7{f@ny+`X<|; zmtbYFOA$V;g_8S3ZHuZ3o2*!Qh`WGGDIlBL#V;l((Xi0xnk+Q@4JXm+CgOP%L) z|9PB=LC0o1*Wx{49qEJtNUM+a8Vi~Nksx30NQl<~T6b{mslrhuvD3OuF@wBb{|wHF z@+?aai=b*spXGVa%e;A->nzd1XGbd)(K}Af671n4#mky=JHdQG&w^v+R zAFvq{Zl^GRsw9DEZGGSt%eJ-ZLC3GPA~M}wvY@JrH$LMJ({se=GV#OJoL4*S3(^b@ z;*WS(&KW%^7Y_+sls2i&8z1}QL1gOp!JD|sKQ;0P5^`9*x80*cpTEpeD2U8~l`j?2 zAcG#uJQ>@7(mp(0voHcuuX@c?{PtsyoLAhZ;_os%5tu080&BmR?T|>+_p=Xb> zsv28vkiuBkbQV5bqQr$Wdf{JJcCtd&+L*&*~l!7hU3lQjaXmPXUQZa%v+~9yU=xKR-QKxr8j7aL+GG-ryrI zT*2YQ(8+W0(p|f4G!DTQHB=)Q{xhFReE>uUr&Dl)LH#r252u^G8X3V=iz$~0rvHfp zLMYB5Z_nna2&Tm1qmwJ2lHO0w|FHVmeb zvd?lS>TyO$6i%#htJxBLvC(2N=~326Yjx2q53R1fE#*YAA>&({`bwuIxs}p@Y+p

2>K{Pno9_b;L4xE|SkC(8e9V0ljjk=4xf11P&wKMfGKuW(fk>+Tn z-KUA`)H{4sl={sqLC^(y?7E z)d|~Wt%P}`uwo671lu+uE_GL~kRxn`ou?T$uxvT{T)w%?MT$T9`8%vzYFC4*(~WdW z6}CIl?bAUlO0D}Jtpm}3*51OlBZ`@;m9BagV?7eMWb$)m#E;A&DYYNnssi-1ALVam z>9yyNJ8F9w7Iv~vW;yFI&X!5DXtl?EC#Qh)@zjH*gX&)$UO@=W-tmuoGFtc1^L?=m z1+p;ry*(#p(-!}w;}>OeoqF2q3^^39kfxx$`U>GppDKcgmKMz+KLl0~)QC^Vp&AP+ zv|~oK(ngoqwnc7qi2(cVS$k(~9UAhc+CIg(#4qb36`35w6tcTPIxQJ~h!f$VLo+|P z1_JS;o>er-Npaq!dfIl`!-)Nx_=9D0ge_4x_Da)fAh}OOqXh-k;v6=xkft zyL6_5r!rU*MPG17hkG_N0VliO!8Yu+@~ju0P!3LUY^%(!VFYWcVyi6ShuHU_K008CgjIHlK*qnX-Z|etZ>r5ak9aa{WyHrFuYL}M)s?Q-c z<5B-ORN3}t+6bb=D7S4+q0&CvM+TspeCPkbN>mm5{(~?-%~nDLmc*{HZ%b#%co!*o zKl!WC^-28x^7g@GBW_zsPwMCM@bP7!^yj=7JYflW@u zQ59Zx*xZjPL|{wL#Zl&N%IabzW|T2fg2Th4^M+v4HM+% zy4C{05c<`onhDR$aaL0G0xPK?|4^fMGs9q6a}|DM;!~&Yw_~{680S1~=L2%W>JtE5 z*$&{w^mEe?j*`CG2@Fg1$Xj%og=IsX#41OpG}r?Q6Q`q&QG#U8FDk88b`O zAu2g4s)W3zs%v0b@~r}esNN-im!cE9KC;kJQD6JDVvopZ~}`gy#7F|xg*}^^q{pmQ6^}dLT`+&I?JBE z*H3lD|L6>}ACxGM<24)G#^pqX26+DHitM>Qi?V2rC#`Kf=Qgyzo;~k@=NWR-Mi<^V zj~Oh%X;S_lYvHs$e_WcE>9Jv$G5S44-DN-q#XFJKL2_v}1!925GU+f&ii7-=x}2&- z&pqkx?LZHuVr4A)`iS{^G>H6B19Nw_GSm<45>(P|Gw2$XNGuwGP*Wzt$>Gk*(OBFb z;cm1L@ucxFvczl$)odi3lek6Kh`;pafv`o;1STNBGxs>V(ogGPAuj{fP^a#?u)+wg+I0K*shUuvLlU@oMYT5 zA?m!OJfe8Loe|ce9PCivMV&iEp{o0(G0cunID!|F+lM=SUnw>ezjrm5h5LIp+eI_Y z+0;r_)YYQE`TOK2AN_I8Mi7KvN2Q9NC3{%qP&!P|KV|a(DS(d2F`7(+-yB%OTMJFM zDSyavls7%*cI%pH{UDok$=1|eavZHtsN}rl9)D-HkdFNuuljqrdd`2fQELpYcCnV$ zxcFsnCN-JxDMV;jsEPE!Nev4o^|M`D%Uqj#ysPy?WAMdmgVO^(M`a#%82ZBLotfb8 zDn(VQk!V+@;OEcRC84bna-1Avk>z!dcBrd7RQ*^td&c@EX96Nnp`EQHy8>9u!$Qmt z$Pr8vh{>1OV|k?HPvLs>!3+1=yHZc)K^~i4JZCJN70bP|{)h14;12zuxHTtWPHFi_ zSO(psc@`^`)_<&WTj4=SisF7b#J#je)J#fT@JU6eAYc=H4`9(LBL8*C9AKG9=n z_tRbsh6{GLhfyl^cP8#)&6`O38^oT7`kmF+*E!tt96<)G2 z_#iLqYQeY|D@LFM%W^y2kB7_dn_jm9IAMCs@=L#9et~RMp*pf)%3`f7Y+ZDxBA+; z_vxn#$|=j2CY`uFVJA@+g`+^(mdcXXt=~ti*`9kn-(kvWiPwYo`f+^nmksY_uk_&oSHd{CV6b5v8hqJF9g+_<|23;}0&E9w zVKq$yu(L0m8?KTfY*8d~M5cr!5g@%58*e1vq(t`&gccIQ4cfgpjul4fBA)cUj7o`*h*hRQ7hK)2=m9ThS#l>)NFl;gGuu7 zHS~r@PSMwYv70kd%9V*!_efMnyy$2jMt>hLhsuqT1xBO>mp)p^e9BXMjs)KuSsNlH zIYBEg?Wgfm(&UHdYqO*Lds&^xoe2d<4zGh{N)AU`8k{f&Y6CQ0OqQt+z8%P*hohsD z7L6n#koNa{teCf0i#A5t{ziVZO2L|5+!-(n$W)PQzctoqwg;Wn@rKUUL}ZWGHE6Kp z>JbL7Ht#x+nME0hDDougtLDBU>l@t?7ow*LeK;ElH+0n;UX_W&TXTpf6}-L&t*c+u zqePY06ICf9hC$dt_3?qMT*A9$-GJg4URvJ@)HNy~j^NgJD?MYwygg}Zv?`tcNgLan zXlk3n9!8*L;r`DHU^lG32XQtQABIh_O!a^#Hz zx1Dplmz2(s#LcVcs`V>6%AYj`CgeYqB$Rs8oo=4MtMB%kPGi5xVd=XyjBs67yW(4) zx}`^c?KF9y+)zd8kc-ss${3P*z1#fcXxPBTd+!AYSH93K<(&_{QPq6_khLj5jTQS# zc+LkJA|oqE6S$-Nvi&^{HTtFk?ZM7TdmG_l^^KK6*MTTq3Whp{JE0}|1>5|O#PC?* z&P(P$==r&71Es+*7BqK)(PJ||x+#uPA6jWl0fmUIn*PY*hIxef|9y;wyl%R#>uz|{ zr@1JmmO>(JaUS+_T{-#>XeEy?>*y-(8&#VRHmi+h{NPpw1ViJrQ9bFlJL#fE8{D0N zo3;g#p(A7)=xEjITm_-tB`V;)&F*lIfF7LeAer^1x`(_<3H0pIqxt)O)@YylGS&1j zTE&DahH$ZN4PfM{m@yHx5Xdf=RT*(JmtZr3U)x1>q*Znd<0$6Hr5`6Ex;YTz{7WB- z5XAuX8sQ&(bQBfWrN(HehN)=LA8S$2D1x`GJ4Z7^1I4s1c-~0j4B-(v+Mo>S`A@;s;j+EQ;ntw>?$y8h;DQs zmS3_(il_>pbsKcQryav8VMP6=oG90{!u;mQu=XU|5NLHw2E#r&bgkI%4^LC$XbZQo zzAF>l@dx&QhuFC&|2Bif&kn(wR+Ma!{5zSNj~RD@B@lGm4F+N50|YJ4`E&QYesJSA zAYFI;XR!(KwT^bZ=bsYRwW~livGl&w-G9E@bmz`bYLfpH`@ezRUzM(WeE%w2`G5Pn z4}curSa06m*kClbFE$6u>K)tsuOHF;^JUEWtVYRb*!kUjtmnr6{o5Tr9fv=Ubqz&$9G--)?dX}?4JEEA+bI` literal 0 HcmV?d00001 diff --git a/book/installation-and-setup/jupyter-book-setup.md b/book/installation-and-setup/jupyter-book-setup.md index 1c98a0b..feab159 100644 --- a/book/installation-and-setup/jupyter-book-setup.md +++ b/book/installation-and-setup/jupyter-book-setup.md @@ -5,15 +5,15 @@ This page is useful for user type 5. ``` -Jupyter book is a regular Python package which converts our content into a website. It's part of all of the `requirements.txt` files for a book repository. At TeachBooks we developed a Python package called `teachbooks` which takes over the jupyter-book features and adds [additional features](/book/features/overview.md). One of those additional features is the workflow to GitHub Pages. +Jupyter book is a regular Python package which converts our content into a website. It's part of all of the `requirements.txt` files for a book repository. At TeachBooks we developed a Python package called `teachbooks` which takes over the these features and adds [additional features](/book/features/overview.md). One of those additional features, for example, is the workflow to GitHub Pages. + +Concretely, this means that the teachbooks package can be used to replace the Jupyter book package when calling these features. You could think of it as `jupyter-book` being a dependency of `teachbooks`. ```{admonition} Note :class: tip -Note that you should specify the package `teachbooks` in the `requirements.txt` files in your book repository. +Don't forget to add the package `teachbooks` in the `requirements.txt` files in your book repository and to have it installed in your working environment (`pip install teachbooks`). ``` -Concretely, this means that the teachbooks package can be used to replace the jupyter-book package when calling jupyter-book features. You could think of it as `jupyter-book` being a dependency of `teachbooks`. - ## Build a book As soon as you've installed your book environment with jupyter-book you can build your book locally. The official Jupyter book documentation is quite extensive. Only two notes: first navigate to the directory where your book is to leave out the `path-to-book` and use `--all` whenever building a book to make sure the table of contents fully updates: @@ -21,14 +21,23 @@ As soon as you've installed your book environment with jupyter-book you can buil ``` teachbooks build --all ``` -Or alternatively: +Alternatively: ``` jupyter-book build --all ``` ## View the book locally -Once the build process is completed successfully, you will see the file location in your terminal output. Simply open this in the browser (you may have to copy/paste). +Once the build process is completed successfully, you will see the file location in your terminal output. Your terminal will look something like this. Simply open this in the browser (you may have to copy/paste). + +```{figure} ../figures/Terminal.PNG +--- +width: 80% +name: terminal +align: center +--- +Terminal +``` ```{admonition} Tip :class: tip, dropdown From efdf29f10a18f6ad6f977ffd6efaef97cc7f1108 Mon Sep 17 00:00:00 2001 From: Julie Kirsch Date: Fri, 6 Sep 2024 16:22:46 +0200 Subject: [PATCH 4/4] final --- book/installation-and-setup/jupyter-book-setup.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/book/installation-and-setup/jupyter-book-setup.md b/book/installation-and-setup/jupyter-book-setup.md index feab159..4787010 100644 --- a/book/installation-and-setup/jupyter-book-setup.md +++ b/book/installation-and-setup/jupyter-book-setup.md @@ -30,7 +30,7 @@ jupyter-book build --all Once the build process is completed successfully, you will see the file location in your terminal output. Your terminal will look something like this. Simply open this in the browser (you may have to copy/paste). -```{figure} ../figures/Terminal.PNG +```{figure} ./figures/Terminal.PNG --- width: 80% name: terminal