From 45bad7acdbfa54269502b402101cdff072335fec Mon Sep 17 00:00:00 2001
From: auphelia <jakobapk@web.de>
Date: Thu, 20 Feb 2020 16:59:29 +0000
Subject: [PATCH] [Sphinx documentation] Change intend to show code as literal
code block
---
docs/finn/_build/doctrees/environment.pickle | Bin 129766 -> 129766 bytes
.../_build/doctrees/getting_started.doctree | Bin 18552 -> 15305 bytes
.../html/_sources/getting_started.rst.txt | 3 +++
docs/finn/_build/html/getting_started.html | 21 ++++++++----------
docs/finn/getting_started.rst | 3 +++
5 files changed, 15 insertions(+), 12 deletions(-)
diff --git a/docs/finn/_build/doctrees/environment.pickle b/docs/finn/_build/doctrees/environment.pickle
index a7171fc3fd93c8a6f37694a82589372376db62be..2292f60c0d33635b5ad7fb39a65581e0b0d6a40e 100644
GIT binary patch
delta 1952
zcmZWpZBUd|6y~6O3cDa;K(?Q-%fiC4FfJp@8jBerDHd7NShFnb0=vMzE6b+%Bbz3j
z)HNK=>UC_K=)<XLQkdQx%W@>O$+EJtG9^u?2~*Q>4E)G}&V2=j+F#GP&w0+reeOH&
z&`8|SNL+t*Ca$WQ7aN+{<nj4>vNG7G!=Pp=8z^O=1kM!(J3VdTkOEijQp^vB<ZhqK
z(J44MG_?t<!=YILA=uIAb~FkucX*<vQRtvJu3c~i+uYclnXZ>fy&8joPNCf)_`{(X
zkI&^^6AmRy38&B5))nvsL~GXEnFdRAR8*Dy6z=Wo^~t;or%tbrto7QaPH(h$#kGpJ
z0ULDbn4y-TM%9MT<)z?&Dh3t$R4mEXV85yWbJRvG*4m>(7PM<Jal2ZHE3zwlau(xb
z>U>GHPp!v&>MXpaNyZO!8jR5vV1>pqYpd5s<GRDSAv2ZgaLklUrA6$r24rZ@(LyoN
zdK}ksTI$GW@@{3y6x^bni%0T{d8dS}Ug2IRH0erkC}#=&M7Tj;jKRFr|7^_XKb~vE
zdP6=Q)+_OwoD6(PXQEyF6T1|lS*O4x!yL+&;`6x=qRLQ#0|tw9mr;W?I#i5mgCW-0
z5D+>VaA~gj|J~4>XTz&`@whbKii>lU<eLsh@-{;q3VHL;V@$!r`6W2Vm_AeR`PQJ^
zs3mC$`lzJXsKzd1YXW~IZcQnzqr{|wEa_TkGUDo@I%yRiZ!1W{?@bF}{)8$iu2E?B
zd+4)x#q`j0w$1JI1^qZySOW_uwfI9pI_e4*O=Aw35_`-ROf0fP)s!q~Qh;^p#0pc<
zVm8I{1-&-0)!Y*g793k}j@pcsYH++P2sSBV)}eGsb#Mkr`G@BHmPa<Rr@VIq6<u%k
zp{mS+r;gOo$-Fod`$iMRWk>Zu$G#_W#8*Fii--0T<?OXf5G%g;`A2jX%fE<=CVKav
zm8q^kir9VpV=mis){4Df$;9y2?{Ss=L^7$w+V3<RI!?-Y4QZIX31s5&ACGWR_o+ml
z-FaGq-GjWbxaTZz==(K>m+U-k6^Abz;_Ck2`Z+j%-vM-6zW#XG1GxTT9k*~|{ks=y
zC@DU2X&Z-gmv?e0^rwlTKWX`e;=|X@a8M6_BIU0i<9VkuO+0WTKAN24U70l%D@W_-
zbg%0Hu!-KAS3u6~teGu&SrhNIq3ia$l#<^$8lB8j8>P%fa`^n+o(8b6fCDNCjE!LC
z4$2Y=oqm5?SJ-P|V-BdG)Pwb~gkV!W&>OJ&77}t#<s{(`R)1eq)P``Vl3ln4S~hS6
zWX$1&G?E6K@H9cM8_eAG8N8>w0UjmJ)C5JGV=J$MeA>wO8=#ERR~uj<0WDRP#D|1p
z+ufZlf{P6}K+gvLf;m#NgN;y6GKC8~1k2MQo$Yc#DaDj2#Jwjo*g7|4NLmt^Cm9tf
zXe&Db?Nh*?TS+l3wSr)@8nUtXWHPI5hS^f>@h0i&%4T?m^24=|&3c<bLGhtxs3G`e
zIcV|x&-2(n&5%6pI%L)&$@WQ?Dwz2u<m336SmqlAxzzne3p_<VB%96;CdT<Y1TVL0
ziwBkxKj?uc3HVg3xG<Yl+=5xrln#2KmU#Oz8a=@$vf*2hI&Hq970OAovK0!!vVT)6
z$Y!kLezsJ%RB!AIdt2!3a;0aSWc(4#nh55F2<GJoW@`kq;~uka+W6iG(K``Le+2Vk
y1Tzr99E)JSoM85E7a*yN+<5a3s7{UN|D0#TUK{)SHf)ad-%lTOfUUm+&VK<Xkda9M
delta 2021
zcmah}YfO`86y_9x0=DHM2u^zgEwrUjJLOg;mrRB@!LYe3&Xqz7ZGpD7Ws_x#W{GBK
z7mcUxGj6(?&1^AV$i5$LZbqCgb8`zb#(6;<WSLHxigDsKu=9RgLed}m!#VGBp7WgZ
zKJQnqKZv{jAg(7nlRGgCs_0Nqj%#<zb3?%xr`u*<7YfSkZkr|Gv9Qq6?s+>Dl(abA
zZiCfrZSV3saV#@!VZ4Aedwlj#a6In}INL)(={Vl$4|qB(9&acZ*Ws~sw%h$7^j6Q4
z1QY$9PG7U#((JL>xoyi~Hm52Bd2Db7>*Gu3q|eATiK3#aD=y$6$HkNcSJBkz(t$ZH
z^VI3Gsh598{sn*%@2WF#jj{oMSJvSyMH2QZb+}k5#RV!I<ltVacBqpPRmB)qYlx-B
zm8t@Krb@vFnk4K|C!juCirjpuC|D`b_1O~a$ySiCidyD~efCzTKj7=a#H@wXTM@s_
z<)%fphH|h^n~r;Q$zYsneAghsl<Y<SHwzExOfY?%9Pei-Ce%F>>MJ!x*rHqp`M5Su
zfqnB+gzZJze7vpB!tXVviTkEwI9G>(Ts>h5d~ZQ2ZRnlSP~w}piKxht(0vtnD>p+>
zVQhWQ5@c#8G|xjB?#-18%pEy`9xR+d(!n%Yi}Tq%KAYW#qdDbh)RtkrUM%b|Kt2rW
z<oK4>gl?@EN3>g_t5&SSwc4WShNV@wUsovHZ%~&uBVhLj@T@Wo2edKRp`VGxiew?*
zqf5dreOo;H0?6E8AzfRC#q>Dm=~*}A&BdYo*_dpgr3>`<NuF5j^!fwNK(hm%8p;Hx
zN~y(!dB%8Aa1o_>F&$oKyPc+Kpo*QbB|ihIDbwSXf_Zp?wCWAT=qV^CU8dPU+U>a5
zm><i&HJ6ERGj11?0i(s&pa@3`)i_qt31%VVO0TD}U0uhb=@0u-UB9u+%x^b`H&N5Q
zRyQh37UPAJ4RkWTn2Co+68IITG(gA0ugvE^{^4_$R`i*<Pj5mj|Nf8P(3v;?6el8h
zUw<j59D*c%>zQvE?cmi?4F4kKL%$witcpGfvG}^PY8HIwWUPlcoU8?;{F(D78ENZ<
z1XkU3NeKJ;nJ|CwDzI?)j~Ldn>ryE{Jb0Y3d;aWU!TQ%upxd(b$4chm#v2WEnq2?c
zjan-5FWub1!nIqw7!`U_`QSgad=bC&&Se%<!`}(@d#735YE9*j-WQ9=Ii|{$CS&DD
z1D(cIkAj(ZJsbiVv$Hlu@Um9yGNbMBek#eHoDxY`savRYlfwhgwl{%^^IM>jg1#Ay
z%t2|q!Rqz4cZFOgZqx$hR9eyq%P4Ga1bPFm(LqG!sf;M>!5U{rMQsWNE4jftkj3>5
zft0gYA(g0pE4)r2Y^NVLxgO0lWlgZ0u>2M%U>LXhHpr%p{Hh5`sC>H#UZ6lrRnKHY
zg0UU;fWu?sdM%*gdhfz4LF`yFG!jj211E+0G)Uui+n|tgsu=LlxeRW-9Wn$ik&Kgw
zk{GmA1qIqCk3F}7a$4$D3L`a;jp1_=uC5hQgx)hP!qpY6@CMa~>mZv8w}PDV<E>Cj
z;YvMZ;lRbY+|yQ&OuG)5RVCOy=~6jod<Z%myBy28M?fa1-*>=kq#@We(4P?J^?6*(
zst=v;GU5GBSVe(N#qz-vuKW=sim2S_f;z%0R?z4PJb@d21j*Cp%iF+AoYie$0Mn7p
zZ6J+a&-`@MIBL2BA(w;RE=PFANyHn0tcyT4L?9nTAlo94o#V**Y2(8Yq%R|oo(SaY
y2&6XxIURxgJb@hf$OALG$c@kbhMHtC`=7HW<T7*rK87u^{^#g}_HrAafb~DanXqgC
diff --git a/docs/finn/_build/doctrees/getting_started.doctree b/docs/finn/_build/doctrees/getting_started.doctree
index e9019db1d85c87fb3b3acdc9844f9fb6046fd455..9136b78c0548a5e389c225a38fa0e56564deac03 100644
GIT binary patch
delta 1098
zcmZ`&T}V@581_4J^Gqq+#r)aY=H~oe8=J#5wM?Pbk9ExQri(BqCq9o;=jKWY(=bD1
zM)jVGsEeQry9(rJ2!Zqih6te-5d=aJ-3UQJL0#GRo|BnUH_ylSe9!xQ&wIZ2{J2gQ
zFX%@yZ_U?D>u1fT9kI@SG0`4ti^h68x@3^yQQp2RYM>UWoxn=HBVZipj@2gP?H!_=
z=Hm%5DJIT~a*9?+Z6qUuT4^QS)l|sz0&WS_DYN-AgiqqmBK1LEVKuQTQ-yXyMq$Cy
zL&l)mTEk5eFu7g&d8Qdt?pP-Y;~h?q!N!Qo1RC8gG7Jy$3zQo+6Cu;^&_2V>sl4fl
zX05O#6{Y6%b6Byx0HJ6Z+_v4s0WG%u%7oKJ_)nVfBg^2m?qtUAkzf&jr*@^H(pg5q
zTyeA3^H)q|FOhl~E5#XX>$Bu96XmUYTF0#um?&Q|W^-!0Jcr*5hAND?$Y6Cg-f5B6
z)$YpFdgWEcUXtU`N^ER_52W&DHgE8##}M%h5Et|jJFI$6@nKCD0$(7IAH>aO2fmFC
z!rns$_0<kQuG{hd1_JDc4G*Q+cc0|6YW62LW9Wk@0<V9F_|z1O{xf{HChNi!xpZra
z5X_p7LP4<^daAPEaexO)o|hljDy~9<yV!IEH`=V!F!vD-M)Q17S9OrTr^)WJ+#Y?H
zo!!O)qpZ<PSmbn?q)S`tFQSGY)HD<tgV#t%Sq{G8xNn>?6`Ilwzh-CB5(-+VKtIzp
zX#ts+2$lG{WeBSX?-2ZW;6)G-q6qT{PZ^}r#-8?Wv41cwCgmZyTtat&wlHHs^%Ydl
zan(;iuhSWVY9y#8LW(-DOwE(S@_6VPZB@h2FIp1kpCtGnX-RNgwIujtY7&VmrFGv4
zcR~k&NGUlE%k}=+bmkEu(k!PlW1T&s+_WccNcN@@?1!b5IDt(%bpp3NS`8bWWAH5U
alZ$Cyoy;pxa*l~NjB5XFben_l;f7!IQ7vWw
delta 1893
zcmZ{kUu;uV9LINVd+Y7Rn00Khu77CD#@4QX&=s~$iTJQcGQDJKLVUon!Cek#ti_H7
zr;x$Jk`XE)JM~H8AYy#e%!|B`@FqrlU=Qd6Mv+L=G$9&|iN<95`<>IvdbjT7mwV3n
z{XXaW`<`>|S113zNYpd#_ontOsh_v;4^l&|t%HO5G>sHX`OzbV!;@w)Jxv$VSuIbR
znrH_*#{Ua!_c0s<Xo3cZ+hKBo@Z;$;zuT78*;$!4OZb^wCvVPpRLnSqW!l?vZGztk
z#C+_C6EcP=WR!;@TdlDzpAqjBnY~E(m3VSN*GPvo(jF%KrI5~N{3fyZeSc25fg8ot
zo3M#xz0mP4f%!XuUNs04pCXb6Bkk5;u!WHO{N>O!^0ScgP{JQrsqp)RJP;*eDEVHf
z_|6JNazxv#h@O4?a{TGUQ#c^hRqH!i8fS+95<goxUFo4J_0T5{R+tG>{9Y>DnlGF%
z#|wo?y@K;SY!Vk*(lKw3gziulg0W}njNA^p$6yV(@2um}J@!6)IU3}*qrE!INl?FH
zJMBS47P;P<(=mlF2cj+YR%6aK%-J#uyTHKNmtj30TXHD}6#hro*WPit#UaQK2g;tJ
zIZ-MetuUM}(Kyp30g{&k2~U@RS()zVh;~vImcY3b9GxdF*7zqqZ;>c}lZ5$D{8jCu
zOuB&f_MgYWs=djL?X{gK`{Anc=0w|*>pcEQl0U>g6LlV^LB=AiZQwEgHU6T`uFK+U
ztG;5{QoXN>>wU$XOZC1w8#1h!#3iDAE7^BzzNkB)>O4P?JWZ0qmOqmRwcljUBXR4h
zI9Ro%Z)02F)}_?dYvy)|(^XtxK}VehyJ5!_fYvPFbLls<HkrGb&*r-D$$EA{QZrWC
z7indE!wC8p8`f$UsmiZrE|5N}Z|66Pl6P5p-^Z@meSl^|$RD8weMGBlFV5`2kbvvM
zx-o15K}^Fik6{kOFBl$T7{KIR5K3iler(D-F>~CU##hIXZqN|`8-i;H=Dgq;$a=lW
z5FkT9j1t|3WkSy;(9=t+^fe)d{w|e7QI1ez;FnN>FGMQAGZji$)jHSz7a_O7vTo%|
zuqw=N<s!XX%bw{%sd(6|&;-7aFF+vpgsi$#^n>}gxNq<u_!(jSPqlhqlKlt;W%se8
zd9yO?ZwxyHuo@u5uMXT(h#UR@JCqfhGT@-Z8dIFlez?<?qy#0+@0LBS(bU<PmIY%R
zn))RrYg3$>QjICjCo`ORtmzd=+i%mHK4luymey*Tk`!iBoSL$YDQh0!?#G(uC2h{8
Vsls*sL$2LhJN0H4Klkk3{{iyc4@3X}
diff --git a/docs/finn/_build/html/_sources/getting_started.rst.txt b/docs/finn/_build/html/_sources/getting_started.rst.txt
index 1e9e2368f..b81479468 100644
--- a/docs/finn/_build/html/_sources/getting_started.rst.txt
+++ b/docs/finn/_build/html/_sources/getting_started.rst.txt
@@ -21,6 +21,7 @@ We use Docker extensively for developing and deploying FINN. If you are not fami
Getting an interactive shell for development or experimentation
***************************************************************
::
+
sh run_docker.sh
Simply running sh run-docker.sh without any additional arguments will clone the dependency repos, create a Docker container and give you a terminal with you can use for development for experimentation.
@@ -32,6 +33,7 @@ Simply running sh run-docker.sh without any additional arguments will clone the
Running the Jupyter notebooks
*****************************
::
+
sh run-docker.sh notebook
This will launch the Jupyter notebook server inside a Docker container, and print a link on the terminal that you can open in your browser to run the FINN notebooks or create new ones.
@@ -43,6 +45,7 @@ The run-docker.sh script forwards ports 8888 for Jupyter and 8081 for Netron, an
Running the test suite directly
*******************************
::
+
sh run-docker.sh test
FINN comes with a set of tests which can be launched using the command above. Note that some of the tests involve extra compilation and the entire test suite may take some time to complete.
diff --git a/docs/finn/_build/html/getting_started.html b/docs/finn/_build/html/getting_started.html
index 17ab04f9e..720cd82b5 100644
--- a/docs/finn/_build/html/getting_started.html
+++ b/docs/finn/_build/html/getting_started.html
@@ -179,10 +179,9 @@
<p>We use Docker extensively for developing and deploying FINN. If you are not familiar with Docker, there are many excellent <a class="reference external" href="https://docker-curriculum.com/">online resources</a> to get started. There is a Dockerfile in the root of the repository, as well as a <cite>run-docker.sh</cite> script that can be launched in the following modes:</p>
<div class="section" id="getting-an-interactive-shell-for-development-or-experimentation">
<h3>Getting an interactive shell for development or experimentation<a class="headerlink" href="#getting-an-interactive-shell-for-development-or-experimentation" title="Permalink to this headline">¶</a></h3>
-<dl class="simple">
-<dt>::</dt><dd><p>sh run_docker.sh</p>
-</dd>
-</dl>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sh</span> <span class="n">run_docker</span><span class="o">.</span><span class="n">sh</span>
+</pre></div>
+</div>
<p>Simply running sh run-docker.sh without any additional arguments will clone the dependency repos, create a Docker container and give you a terminal with you can use for development for experimentation.</p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
@@ -195,10 +194,9 @@
</div>
<div class="section" id="running-the-jupyter-notebooks">
<h3>Running the Jupyter notebooks<a class="headerlink" href="#running-the-jupyter-notebooks" title="Permalink to this headline">¶</a></h3>
-<dl class="simple">
-<dt>::</dt><dd><p>sh run-docker.sh notebook</p>
-</dd>
-</dl>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sh</span> <span class="n">run</span><span class="o">-</span><span class="n">docker</span><span class="o">.</span><span class="n">sh</span> <span class="n">notebook</span>
+</pre></div>
+</div>
<p>This will launch the Jupyter notebook server inside a Docker container, and print a link on the terminal that you can open in your browser to run the FINN notebooks or create new ones.
.. note:: The link will look something like this (the token you get will be different):
<a class="reference external" href="http://127.0.0.1:8888/?token=f5c6bd32ae93ec103a88152214baedff4ce1850d81065bfc">http://127.0.0.1:8888/?token=f5c6bd32ae93ec103a88152214baedff4ce1850d81065bfc</a></p>
@@ -206,10 +204,9 @@
</div>
<div class="section" id="running-the-test-suite-directly">
<h3>Running the test suite directly<a class="headerlink" href="#running-the-test-suite-directly" title="Permalink to this headline">¶</a></h3>
-<dl class="simple">
-<dt>::</dt><dd><p>sh run-docker.sh test</p>
-</dd>
-</dl>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sh</span> <span class="n">run</span><span class="o">-</span><span class="n">docker</span><span class="o">.</span><span class="n">sh</span> <span class="n">test</span>
+</pre></div>
+</div>
<p>FINN comes with a set of tests which can be launched using the command above. Note that some of the tests involve extra compilation and the entire test suite may take some time to complete.</p>
</div>
<div class="section" id="running-the-test-suite-using-jenkins">
diff --git a/docs/finn/getting_started.rst b/docs/finn/getting_started.rst
index 1e9e2368f..b81479468 100644
--- a/docs/finn/getting_started.rst
+++ b/docs/finn/getting_started.rst
@@ -21,6 +21,7 @@ We use Docker extensively for developing and deploying FINN. If you are not fami
Getting an interactive shell for development or experimentation
***************************************************************
::
+
sh run_docker.sh
Simply running sh run-docker.sh without any additional arguments will clone the dependency repos, create a Docker container and give you a terminal with you can use for development for experimentation.
@@ -32,6 +33,7 @@ Simply running sh run-docker.sh without any additional arguments will clone the
Running the Jupyter notebooks
*****************************
::
+
sh run-docker.sh notebook
This will launch the Jupyter notebook server inside a Docker container, and print a link on the terminal that you can open in your browser to run the FINN notebooks or create new ones.
@@ -43,6 +45,7 @@ The run-docker.sh script forwards ports 8888 for Jupyter and 8081 for Netron, an
Running the test suite directly
*******************************
::
+
sh run-docker.sh test
FINN comes with a set of tests which can be launched using the command above. Note that some of the tests involve extra compilation and the entire test suite may take some time to complete.
--
GitLab