Skip to content
This repository has been archived by the owner on Mar 10, 2023. It is now read-only.

Commit

Permalink
New docs build
Browse files Browse the repository at this point in the history
  • Loading branch information
talavis committed Jul 5, 2021
1 parent 6538745 commit 371f57a
Show file tree
Hide file tree
Showing 29 changed files with 255 additions and 31 deletions.
1 change: 1 addition & 0 deletions docs/build/html/code.app.html
Original file line number Diff line number Diff line change
Expand Up @@ -148,6 +148,7 @@ <h3>Navigation</h3>
<li class="toctree-l1"><a class="reference internal" href="api.html">API</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="development.html">Development</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="development.quick_environment.html">System for development</a></li>
<li class="toctree-l2"><a class="reference internal" href="development.testing.html">Testing</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="modules.html">Code reference</a></li>
</ul>
</li>
Expand Down
1 change: 1 addition & 0 deletions docs/build/html/code.collection.html
Original file line number Diff line number Diff line change
Expand Up @@ -149,6 +149,7 @@ <h3>Navigation</h3>
<li class="toctree-l1"><a class="reference internal" href="api.html">API</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="development.html">Development</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="development.quick_environment.html">System for development</a></li>
<li class="toctree-l2"><a class="reference internal" href="development.testing.html">Testing</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="modules.html">Code reference</a></li>
</ul>
</li>
Expand Down
1 change: 1 addition & 0 deletions docs/build/html/code.config.html
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,7 @@ <h3>Navigation</h3>
<li class="toctree-l1"><a class="reference internal" href="api.html">API</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="development.html">Development</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="development.quick_environment.html">System for development</a></li>
<li class="toctree-l2"><a class="reference internal" href="development.testing.html">Testing</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="modules.html">Code reference</a></li>
</ul>
</li>
Expand Down
1 change: 1 addition & 0 deletions docs/build/html/code.dataset.html
Original file line number Diff line number Diff line change
Expand Up @@ -164,6 +164,7 @@ <h3>Navigation</h3>
<li class="toctree-l1"><a class="reference internal" href="api.html">API</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="development.html">Development</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="development.quick_environment.html">System for development</a></li>
<li class="toctree-l2"><a class="reference internal" href="development.testing.html">Testing</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="modules.html">Code reference</a></li>
</ul>
</li>
Expand Down
1 change: 1 addition & 0 deletions docs/build/html/code.db_management.html
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,7 @@ <h3>Navigation</h3>
<li class="toctree-l1"><a class="reference internal" href="api.html">API</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="development.html">Development</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="development.quick_environment.html">System for development</a></li>
<li class="toctree-l2"><a class="reference internal" href="development.testing.html">Testing</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="modules.html">Code reference</a></li>
</ul>
</li>
Expand Down
1 change: 1 addition & 0 deletions docs/build/html/code.developer.html
Original file line number Diff line number Diff line change
Expand Up @@ -160,6 +160,7 @@ <h3>Navigation</h3>
<li class="toctree-l1"><a class="reference internal" href="api.html">API</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="development.html">Development</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="development.quick_environment.html">System for development</a></li>
<li class="toctree-l2"><a class="reference internal" href="development.testing.html">Testing</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="modules.html">Code reference</a></li>
</ul>
</li>
Expand Down
10 changes: 10 additions & 0 deletions docs/build/html/code.migrations.html
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,15 @@
</ul>
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="migrations.migrate_v2_to_v3">
<span class="sig-prename descclassname"><span class="pre">migrations.</span></span><span class="sig-name descname"><span class="pre">migrate_v2_to_v3</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">db</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="modules/migrations.html#migrate_v2_to_v3"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#migrations.migrate_v2_to_v3" title="Permalink to this definition"></a></dt>
<dd><p>Update the database fields to match the changes in the data structure.</p>
<ul class="simple">
<li><p>Remove the <code class="docutils literal notranslate"><span class="pre">DATA_LIST</span></code> and <code class="docutils literal notranslate"><span class="pre">STATISTICS</span></code> permissions from all users.</p></li>
</ul>
</dd></dl>

</div>


Expand Down Expand Up @@ -80,6 +89,7 @@ <h3>Navigation</h3>
<li class="toctree-l1"><a class="reference internal" href="api.html">API</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="development.html">Development</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="development.quick_environment.html">System for development</a></li>
<li class="toctree-l2"><a class="reference internal" href="development.testing.html">Testing</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="modules.html">Code reference</a></li>
</ul>
</li>
Expand Down
1 change: 1 addition & 0 deletions docs/build/html/code.order.html
Original file line number Diff line number Diff line change
Expand Up @@ -198,6 +198,7 @@ <h3>Navigation</h3>
<li class="toctree-l1"><a class="reference internal" href="api.html">API</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="development.html">Development</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="development.quick_environment.html">System for development</a></li>
<li class="toctree-l2"><a class="reference internal" href="development.testing.html">Testing</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="modules.html">Code reference</a></li>
</ul>
</li>
Expand Down
1 change: 1 addition & 0 deletions docs/build/html/code.schema.html
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,7 @@ <h3>Navigation</h3>
<li class="toctree-l1"><a class="reference internal" href="api.html">API</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="development.html">Development</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="development.quick_environment.html">System for development</a></li>
<li class="toctree-l2"><a class="reference internal" href="development.testing.html">Testing</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="modules.html">Code reference</a></li>
</ul>
</li>
Expand Down
1 change: 1 addition & 0 deletions docs/build/html/code.structure.html
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,7 @@ <h3>Navigation</h3>
<li class="toctree-l1"><a class="reference internal" href="api.html">API</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="development.html">Development</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="development.quick_environment.html">System for development</a></li>
<li class="toctree-l2"><a class="reference internal" href="development.testing.html">Testing</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="modules.html">Code reference</a></li>
</ul>
</li>
Expand Down
1 change: 1 addition & 0 deletions docs/build/html/code.user.html
Original file line number Diff line number Diff line change
Expand Up @@ -295,6 +295,7 @@ <h3>Navigation</h3>
<li class="toctree-l1"><a class="reference internal" href="api.html">API</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="development.html">Development</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="development.quick_environment.html">System for development</a></li>
<li class="toctree-l2"><a class="reference internal" href="development.testing.html">Testing</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="modules.html">Code reference</a></li>
</ul>
</li>
Expand Down
1 change: 1 addition & 0 deletions docs/build/html/code.utils.html
Original file line number Diff line number Diff line change
Expand Up @@ -752,6 +752,7 @@ <h3>Navigation</h3>
<li class="toctree-l1"><a class="reference internal" href="api.html">API</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="development.html">Development</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="development.quick_environment.html">System for development</a></li>
<li class="toctree-l2"><a class="reference internal" href="development.testing.html">Testing</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="modules.html">Code reference</a></li>
</ul>
</li>
Expand Down
1 change: 1 addition & 0 deletions docs/build/html/code.validate.html
Original file line number Diff line number Diff line change
Expand Up @@ -367,6 +367,7 @@ <h3>Navigation</h3>
<li class="toctree-l1"><a class="reference internal" href="api.html">API</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="development.html">Development</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="development.quick_environment.html">System for development</a></li>
<li class="toctree-l2"><a class="reference internal" href="development.testing.html">Testing</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="modules.html">Code reference</a></li>
</ul>
</li>
Expand Down
6 changes: 6 additions & 0 deletions docs/build/html/development.html
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,11 @@ <h1>Development<a class="headerlink" href="#development" title="Permalink to thi
<li class="toctree-l2"><a class="reference internal" href="development.quick_environment.html#add-test-data">Add test data</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="development.testing.html">Testing</a><ul>
<li class="toctree-l2"><a class="reference internal" href="development.testing.html#backend">Backend</a></li>
<li class="toctree-l2"><a class="reference internal" href="development.testing.html#frontend">Frontend</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="modules.html">Code reference</a><ul>
<li class="toctree-l2"><a class="reference internal" href="code.app.html">app.py</a></li>
<li class="toctree-l2"><a class="reference internal" href="code.collection.html">collection.py</a></li>
Expand Down Expand Up @@ -89,6 +94,7 @@ <h3>Navigation</h3>
<li class="toctree-l1"><a class="reference internal" href="api.html">API</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Development</a><ul>
<li class="toctree-l2"><a class="reference internal" href="development.quick_environment.html">System for development</a></li>
<li class="toctree-l2"><a class="reference internal" href="development.testing.html">Testing</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules.html">Code reference</a></li>
</ul>
</li>
Expand Down
5 changes: 3 additions & 2 deletions docs/build/html/development.quick_environment.html
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<script src="static/doctools.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Code reference" href="modules.html" />
<link rel="next" title="Testing" href="development.testing.html" />
<link rel="prev" title="Development" href="development.html" />

<link rel="stylesheet" href="static/custom.css" type="text/css" />
Expand Down Expand Up @@ -88,6 +88,7 @@ <h3>Navigation</h3>
<li class="toctree-l1"><a class="reference internal" href="api.html">API</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="development.html">Development</a><ul class="current">
<li class="toctree-l2 current"><a class="current reference internal" href="#">System for development</a></li>
<li class="toctree-l2"><a class="reference internal" href="development.testing.html">Testing</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules.html">Code reference</a></li>
</ul>
</li>
Expand All @@ -99,7 +100,7 @@ <h3>Related Topics</h3>
<li><a href="index.html">Documentation overview</a><ul>
<li><a href="development.html">Development</a><ul>
<li>Previous: <a href="development.html" title="previous chapter">Development</a></li>
<li>Next: <a href="modules.html" title="next chapter">Code reference</a></li>
<li>Next: <a href="development.testing.html" title="next chapter">Testing</a></li>
</ul></li>
</ul></li>
</ul>
Expand Down
141 changes: 141 additions & 0 deletions docs/build/html/development.testing.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,141 @@

<!DOCTYPE html>

<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Testing &#8212; Data Tracker documentation</title>
<link rel="stylesheet" type="text/css" href="static/pygments.css" />
<link rel="stylesheet" type="text/css" href="static/alabaster.css" />
<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>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Code reference" href="modules.html" />
<link rel="prev" title="System for development" href="development.quick_environment.html" />

<link rel="stylesheet" href="static/custom.css" type="text/css" />


<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />

</head><body>


<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">


<div class="body" role="main">

<div class="section" id="testing">
<h1>Testing<a class="headerlink" href="#testing" title="Permalink to this headline"></a></h1>
<p>All tests require an active setup of the Data Tracker via docker-compose and test data in the database (See <a class="reference internal" href="development.quick_environment.html"><span class="doc">System for development</span></a>)</p>
<p>Most tests are not deterministic and do not restore the state of the db afterwards.</p>
<div class="section" id="backend">
<h2>Backend<a class="headerlink" href="#backend" title="Permalink to this headline"></a></h2>
<p>The tests are found in <code class="docutils literal notranslate"><span class="pre">backend/tests</span></code>. Use the same <code class="docutils literal notranslate"><span class="pre">venv</span></code> used to add data to the database.</p>
<p>From the root of the repository:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">PYTHONPATH</span><span class="o">=</span><span class="n">backend</span> <span class="n">pytest</span> <span class="n">backend</span>
</pre></div>
</div>
</div>
<div class="section" id="frontend">
<h2>Frontend<a class="headerlink" href="#frontend" title="Permalink to this headline"></a></h2>
<p>Frontend testing is implemented using the end-to-end testing solution Nightwatch.</p>
<p>Go to <code class="docutils literal notranslate"><span class="pre">test/nighwatch</span></code> and run <code class="docutils literal notranslate"><span class="pre">yarn</span> <span class="pre">install</span></code> to install the required packages.</p>
<p>Nightwatch can use multiple different browsers, but the tests have only been confirmed to work with Chrome.</p>
<p>To run the tests (in the <code class="docutils literal notranslate"><span class="pre">test/nighwatch</span></code> folder):</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">npx</span> <span class="n">nightwatch</span> <span class="n">collection</span><span class="o">.</span><span class="n">js</span> <span class="o">--</span><span class="n">env</span> <span class="n">chrome</span>
</pre></div>
</div>
</div>
</div>


</div>

</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="index.html">
<img class="logo" src="static/SciLifeLab_symbol_green.svg" alt="Logo"/>
</a></p>
<h1 class="logo"><a href="index.html">Data Tracker</a></h1>








<h3>Navigation</h3>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="design.html">System Design</a></li>
<li class="toctree-l1"><a class="reference internal" href="configuration.html">Configuration</a></li>
<li class="toctree-l1"><a class="reference internal" href="data_structure.html">Data Structure</a></li>
<li class="toctree-l1"><a class="reference internal" href="api.html">API</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="development.html">Development</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="development.quick_environment.html">System for development</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">Testing</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules.html">Code reference</a></li>
</ul>
</li>
</ul>

<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="index.html">Documentation overview</a><ul>
<li><a href="development.html">Development</a><ul>
<li>Previous: <a href="development.quick_environment.html" title="previous chapter">System for development</a></li>
<li>Next: <a href="modules.html" title="next chapter">Code reference</a></li>
</ul></li>
</ul></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" />
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>$('#searchbox').show(0);</script>








</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
&copy;2019-2021, SciLifeLab Data Centre.

|
Powered by <a href="http://sphinx-doc.org/">Sphinx 4.0.2</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>

|
<a href="sources/development.testing.md.txt"
rel="nofollow">Page source</a>
</div>




</body>
</html>
2 changes: 2 additions & 0 deletions docs/build/html/genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -359,6 +359,8 @@ <h2 id="M">M</h2>
<li><a href="code.utils.html#utils.make_timestamp">make_timestamp() (in module utils)</a>
</li>
<li><a href="code.migrations.html#migrations.migrate_v1_to_v2">migrate_v1_to_v2() (in module migrations)</a>
</li>
<li><a href="code.migrations.html#migrations.migrate_v2_to_v3">migrate_v2_to_v3() (in module migrations)</a>
</li>
<li>
migrations
Expand Down
1 change: 1 addition & 0 deletions docs/build/html/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@ <h1>Data Tracker<a class="headerlink" href="#data-tracker" title="Permalink to t
</li>
<li class="toctree-l1"><a class="reference internal" href="development.html">Development</a><ul>
<li class="toctree-l2"><a class="reference internal" href="development.quick_environment.html">System for development</a></li>
<li class="toctree-l2"><a class="reference internal" href="development.testing.html">Testing</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules.html">Code reference</a></li>
</ul>
</li>
Expand Down
5 changes: 3 additions & 2 deletions docs/build/html/modules.html
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="app.py" href="code.app.html" />
<link rel="prev" title="System for development" href="development.quick_environment.html" />
<link rel="prev" title="Testing" href="development.testing.html" />

<link rel="stylesheet" href="static/custom.css" type="text/css" />

Expand Down Expand Up @@ -80,6 +80,7 @@ <h3>Navigation</h3>
<li class="toctree-l1"><a class="reference internal" href="api.html">API</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="development.html">Development</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="development.quick_environment.html">System for development</a></li>
<li class="toctree-l2"><a class="reference internal" href="development.testing.html">Testing</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">Code reference</a></li>
</ul>
</li>
Expand All @@ -90,7 +91,7 @@ <h3>Related Topics</h3>
<ul>
<li><a href="index.html">Documentation overview</a><ul>
<li><a href="development.html">Development</a><ul>
<li>Previous: <a href="development.quick_environment.html" title="previous chapter">System for development</a></li>
<li>Previous: <a href="development.testing.html" title="previous chapter">Testing</a></li>
<li>Next: <a href="code.app.html" title="next chapter">app.py</a></li>
</ul></li>
</ul></li>
Expand Down
Loading

0 comments on commit 371f57a

Please sign in to comment.