Update documentation (#222)

* update documentation * add documentation page 'about this docuemntation' * update about documentation
amosproj · Jul 12, 2021 · 4c66205 · 4c66205
1 parent 62d5690
commit 4c66205
Show file tree

Hide file tree

Showing 28 changed files with 334 additions and 9 deletions.
diff --git a/docs/About this Documentation.html b/docs/About this Documentation.html
@@ -0,0 +1,236 @@
+
+
+<!DOCTYPE html>
+<html class="writer-html5" lang="en" >
+<head>
+  <meta charset="utf-8" />
+
+  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+
+  <title>About this Documentation &mdash; Neural Network Enablement  documentation</title>
+
+
+
+  <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
+  <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
+  <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
+  <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
+
+
+
+
+
+
+
+
+
+
+  <!--[if lt IE 9]>
+    <script src="_static/js/html5shiv.min.js"></script>
+  <![endif]-->
+
+
+      <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
+        <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
+        <script src="_static/jquery.js"></script>
+        <script src="_static/underscore.js"></script>
+        <script src="_static/doctools.js"></script>
+
+    <script type="text/javascript" src="_static/js/theme.js"></script>
+
+
+    <link rel="index" title="Index" href="genindex.html" />
+    <link rel="search" title="Search" href="search.html" />
+    <link rel="next" title="License" href="License.html" />
+    <link rel="prev" title="colorization.atlas_utils.lib package" href="colorization.atlas_utils.lib.html" /> 
+</head>
+
+<body class="wy-body-for-nav">
+
+
+  <div class="wy-grid-for-nav">
+
+    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+      <div class="wy-side-scroll">
+        <div class="wy-side-nav-search" >
+
+
+
+            <a href="index.html" class="icon icon-home"> Neural Network Enablement
+
+
+
+          </a>
+
+
+
+
+
+
+
+<div role="search">
+  <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
+    <input type="text" name="q" placeholder="Search docs" />
+    <input type="hidden" name="check_keywords" value="yes" />
+    <input type="hidden" name="area" value="default" />
+  </form>
+</div>
+
+
+        </div>
+
+
+        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+
+
+
+              <p class="caption"><span class="caption-text">Table Of Contents:</span></p>
+<ul class="current">
+<li class="toctree-l1"><a class="reference internal" href="Description.html">Neural Network Enablement</a></li>
+<li class="toctree-l1"><a class="reference internal" href="User%20Documentation.html">User Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="Architecture.html">Architecture</a></li>
+<li class="toctree-l1"><a class="reference internal" href="Build%20%26%20Deploy.html">Build &amp; Deploy</a></li>
+<li class="toctree-l1"><a class="reference internal" href="Source%20Code%20Documentation.html">Source Code Documentation</a></li>
+<li class="toctree-l1 current"><a class="current reference internal" href="#">About this Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="License.html">License</a></li>
+</ul>
+
+
+
+        </div>
+
+      </div>
+    </nav>
+
+    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+      <nav class="wy-nav-top" aria-label="top navigation">
+
+          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+          <a href="index.html">Neural Network Enablement</a>
+
+      </nav>
+
+
+      <div class="wy-nav-content">
+
+        <div class="rst-content">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<div role="navigation" aria-label="breadcrumbs navigation">
+
+  <ul class="wy-breadcrumbs">
+
+      <li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
+
+      <li>About this Documentation</li>
+
+
+      <li class="wy-breadcrumbs-aside">
+
+
+            <a href="_sources/About this Documentation.rst.txt" rel="nofollow"> View page source</a>
+
+
+      </li>
+
+  </ul>
+
+
+  <hr/>
+</div>
+          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+           <div itemprop="articleBody">
+
+  <div class="section" id="about-this-documentation">
+<h1>About this Documentation<a class="headerlink" href="#about-this-documentation" title="Permalink to this headline">¶</a></h1>
+<p><strong>Generating the documentation</strong></p>
+<p>We use sphinx to generate the documenation. It extracts doc-strings from the relevant python-files and combines them with the documentation from sphinx/source.</p>
+<p>The result is saved in the docs-folder. Don’t change anything here, as it will be overwritten when running the script.</p>
+<p>To generate the documentation run <cite>scripts/generate_documentation.sh</cite>.</p>
+<p><strong>Limitations</strong></p>
+<p>There are multiple errors that can occur during generating the documentation:</p>
+<ol class="arabic simple">
+<li><p>libatlasutil.so not found</p></li>
+</ol>
+<p>This error can be ignored.</p>
+<ol class="arabic simple" start="2">
+<li><p>modules.rst: WARNING: document isn’t included in any toctree</p></li>
+</ol>
+<p>This error can be ignored.</p>
+<ol class="arabic simple" start="3">
+<li><p>The extraction of the documentation for app.py fails</p></li>
+</ol>
+<p>Sphinx sometimes gets confused about relative imports. Removing the dots from the import-statements in all relevant python-files might help. (Only apply this change for generating the documentation)</p>
+</div>
+
+
+           </div>
+
+          </div>
+          <footer>
+    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+        <a href="License.html" class="btn btn-neutral float-right" title="License" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
+        <a href="colorization.atlas_utils.lib.html" class="btn btn-neutral float-left" title="colorization.atlas_utils.lib package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
+    </div>
+
+  <hr/>
+
+  <div role="contentinfo">
+    <p>
+        &#169; Copyright 2021, Susmitha, Wolfgang, Xiangxiang, Emma, Yilin, Maximilian, Philipp.
+
+    </p>
+  </div>
+
+
+
+    Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
+
+    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
+
+    provided by <a href="https://readthedocs.org">Read the Docs</a>. 
+
+</footer>
+        </div>
+      </div>
+
+    </section>
+
+  </div>
+
+
+  <script type="text/javascript">
+      jQuery(function () {
+          SphinxRtdTheme.Navigation.enable(true);
+      });
+  </script>
+
+
+
+
+
+
+</body>
+</html>
diff --git a/docs/Architecture.html b/docs/Architecture.html
@@ -94,6 +94,7 @@
 <li class="toctree-l1 current"><a class="current reference internal" href="#">Architecture</a></li>
 <li class="toctree-l1"><a class="reference internal" href="Build%20%26%20Deploy.html">Build &amp; Deploy</a></li>
 <li class="toctree-l1"><a class="reference internal" href="Source%20Code%20Documentation.html">Source Code Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="About%20this%20Documentation.html">About this Documentation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="License.html">License</a></li>
 </ul>
 

diff --git a/docs/Backend.html b/docs/Backend.html
@@ -101,6 +101,7 @@
 </li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="About%20this%20Documentation.html">About this Documentation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="License.html">License</a></li>
 </ul>
 

diff --git a/docs/Build & Deploy.html b/docs/Build & Deploy.html
@@ -94,6 +94,7 @@
 <li class="toctree-l1"><a class="reference internal" href="Architecture.html">Architecture</a></li>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">Build &amp; Deploy</a></li>
 <li class="toctree-l1"><a class="reference internal" href="Source%20Code%20Documentation.html">Source Code Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="About%20this%20Documentation.html">About this Documentation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="License.html">License</a></li>
 </ul>
 
@@ -203,7 +204,9 @@ <h1>Build &amp; Deploy<a class="headerlink" href="#build-deploy" title="Permalin
 <p><strong>OpenCV</strong></p>
 <p>OpenCV is automatically installed into the virtual environment, it doesn’t have to be available system-wide.</p>
 <p><strong>Setup</strong></p>
-<p>The script <cite>scripts/setup.sh</cite> sets up a virtual environment for python initially.</p>
+<p>The first step is to clone the repository from github:</p>
+<p><cite>git clone https://github.com/amosproj/amos-ss2021-neural-network-enablement</cite></p>
+<p>Then the script <cite>scripts/setup.sh</cite> sets up a virtual environment for python.</p>
 <p>If the environment is set up already, it updates the dependencies.</p>
 <p><strong>Build</strong></p>
 <p>There is no explicit build step. It can be run directly after a successful setup.</p>

diff --git a/docs/Description.html b/docs/Description.html
@@ -94,6 +94,7 @@
 <li class="toctree-l1"><a class="reference internal" href="Architecture.html">Architecture</a></li>
 <li class="toctree-l1"><a class="reference internal" href="Build%20%26%20Deploy.html">Build &amp; Deploy</a></li>
 <li class="toctree-l1"><a class="reference internal" href="Source%20Code%20Documentation.html">Source Code Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="About%20this%20Documentation.html">About this Documentation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="License.html">License</a></li>
 </ul>
 

diff --git a/docs/License.html b/docs/License.html
@@ -41,7 +41,7 @@
 
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
-    <link rel="prev" title="colorization.atlas_utils.lib package" href="colorization.atlas_utils.lib.html" /> 
+    <link rel="prev" title="About this Documentation" href="About%20this%20Documentation.html" /> 
 </head>
 
 <body class="wy-body-for-nav">
@@ -93,6 +93,7 @@
 <li class="toctree-l1"><a class="reference internal" href="Architecture.html">Architecture</a></li>
 <li class="toctree-l1"><a class="reference internal" href="Build%20%26%20Deploy.html">Build &amp; Deploy</a></li>
 <li class="toctree-l1"><a class="reference internal" href="Source%20Code%20Documentation.html">Source Code Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="About%20this%20Documentation.html">About this Documentation</a></li>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">License</a></li>
 </ul>
 
@@ -188,7 +189,7 @@ <h1>License<a class="headerlink" href="#license" title="Permalink to this headli
           </div>
           <footer>
     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
-        <a href="colorization.atlas_utils.lib.html" class="btn btn-neutral float-left" title="colorization.atlas_utils.lib package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
+        <a href="About%20this%20Documentation.html" class="btn btn-neutral float-left" title="About this Documentation" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
     </div>
 
   <hr/>

diff --git a/docs/Source Code Documentation.html b/docs/Source Code Documentation.html
@@ -98,6 +98,7 @@
 <li class="toctree-l2"><a class="reference internal" href="Backend.html">Backend colorization</a></li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="About%20this%20Documentation.html">About this Documentation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="License.html">License</a></li>
 </ul>
 

diff --git a/docs/User Documentation.html b/docs/User Documentation.html
@@ -94,6 +94,7 @@
 <li class="toctree-l1"><a class="reference internal" href="Architecture.html">Architecture</a></li>
 <li class="toctree-l1"><a class="reference internal" href="Build%20%26%20Deploy.html">Build &amp; Deploy</a></li>
 <li class="toctree-l1"><a class="reference internal" href="Source%20Code%20Documentation.html">Source Code Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="About%20this%20Documentation.html">About this Documentation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="License.html">License</a></li>
 </ul>
 

diff --git a/docs/Webservice.html b/docs/Webservice.html
@@ -102,6 +102,7 @@
 <li class="toctree-l2"><a class="reference internal" href="Backend.html">Backend colorization</a></li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="About%20this%20Documentation.html">About this Documentation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="License.html">License</a></li>
 </ul>
 

diff --git a/docs/_sources/About this Documentation.rst.txt b/docs/_sources/About this Documentation.rst.txt
@@ -0,0 +1,27 @@
+About this Documentation
+========================
+
+**Generating the documentation**
+
+We use sphinx to generate the documenation. It extracts doc-strings from the relevant python-files and combines them with the documentation from sphinx/source.
+
+The result is saved in the docs-folder. Don't change anything here, as it will be overwritten when running the script.
+
+To generate the documentation run `scripts/generate_documentation.sh`.
+
+
+**Limitations**
+
+There are multiple errors that can occur during generating the documentation:
+
+1. libatlasutil.so not found
+
+This error can be ignored.
+
+2. modules.rst: WARNING: document isn't included in any toctree
+
+This error can be ignored.
+
+3. The extraction of the documentation for app.py fails
+
+Sphinx sometimes gets confused about relative imports. Removing the dots from the import-statements in all relevant python-files might help. (Only apply this change for generating the documentation)
diff --git a/docs/_sources/Build & Deploy.rst.txt b/docs/_sources/Build & Deploy.rst.txt
@@ -64,7 +64,11 @@ OpenCV is automatically installed into the virtual environment, it doesn't have
 
 **Setup**
 
-The script `scripts/setup.sh` sets up a virtual environment for python initially.
+The first step is to clone the repository from github:
+
+`git clone https://github.com/amosproj/amos-ss2021-neural-network-enablement`
+
+Then the script `scripts/setup.sh` sets up a virtual environment for python.
 
 If the environment is set up already, it updates the dependencies.
 

diff --git a/docs/_sources/index.rst.txt b/docs/_sources/index.rst.txt
@@ -14,6 +14,7 @@ Welcome to Neural Network Enablement's documentation!
    Architecture
    Build & Deploy
    Source Code Documentation
+   About this Documentation
    License
 
 

diff --git a/docs/app.html b/docs/app.html
@@ -102,6 +102,7 @@
 <li class="toctree-l2"><a class="reference internal" href="Backend.html">Backend colorization</a></li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="About%20this%20Documentation.html">About this Documentation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="License.html">License</a></li>
 </ul>
 

diff --git a/docs/colorization.atlas_utils.html b/docs/colorization.atlas_utils.html
@@ -94,6 +94,7 @@
 <li class="toctree-l1"><a class="reference internal" href="Architecture.html">Architecture</a></li>
 <li class="toctree-l1"><a class="reference internal" href="Build%20%26%20Deploy.html">Build &amp; Deploy</a></li>
 <li class="toctree-l1"><a class="reference internal" href="Source%20Code%20Documentation.html">Source Code Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="About%20this%20Documentation.html">About this Documentation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="License.html">License</a></li>
 </ul>
-Original file line number
+Diff line change
@@ Expand Up / @@ -101,6 +101,7 @@ @@
     </li>
     </ul>
     </li>
+    <li class="toctree-l1"><a class="reference internal" href="About%20this%20Documentation.html">About this Documentation</a></li>
     <li class="toctree-l1"><a class="reference internal" href="License.html">License</a></li>
     </ul>
@@ Expand Down @@