Skip to content
Snippets Groups Projects
Commit 45bad7ac authored by auphelia's avatar auphelia
Browse files

[Sphinx documentation] Change intend to show code as literal code block

parent f123815e
No related branches found
No related tags found
No related merge requests found
No preview for this file type
No preview for this file type
......@@ -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.
......
......@@ -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">
......
......@@ -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.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment