Skip to content

Commit

Permalink
doc
Browse files Browse the repository at this point in the history
  • Loading branch information
@dodu94
dodu94 committed Jun 24, 2021
1 parent 012b6a8 commit d1c6c2d
Show file tree
Hide file tree
Showing 11 changed files with 44 additions and 20 deletions.
Binary file modified docs/source/_build/html/.doctrees/environment.pickle
View file
Binary file not shown.
3 changes: 2 additions & 1 deletion docs/source/_build/html/contributors.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,7 @@
<li class="toctree-l1"><a class="reference internal" href="usage/folders.html">Folder Structure</a></li>
<li class="toctree-l1"><a class="reference internal" href="usage/configuration.html">Configuration</a></li>
<li class="toctree-l1"><a class="reference internal" href="usage/menu.html">Usage</a></li>
<li class="toctree-l1"><a class="reference internal" href="usage/benchmarks.html">Default Benchmarks</a></li>
<li class="toctree-l1"><a class="reference internal" href="usage/postprocessing.html">Post-Processing Gallery</a></li>
<li class="toctree-l1"><a class="reference internal" href="usage/utilities.html">Utilities</a></li>
<li class="toctree-l1"><a class="reference internal" href="usage/tipstricks.html">Tips &amp; Tricks</a></li>
Expand All @@ -110,7 +111,7 @@
</ul>
<p class="caption"><span class="caption-text">JADE Developer Guide (TBD):</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="LICENSE.html">License</a></li>
<li class="toctree-l1"><a class="reference internal" href="dev/intro.html">Introduction</a></li>
</ul>


Expand Down
10 changes: 7 additions & 3 deletions docs/source/_build/html/dev/intro.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,8 @@


<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="prev" title="List of Publications and Contributions" href="../publications.html" />
</head>

<body class="wy-body-for-nav">
Expand Down Expand Up @@ -108,8 +109,8 @@
<li class="toctree-l1"><a class="reference internal" href="../publications.html">List of Publications and Contributions</a></li>
</ul>
<p class="caption"><span class="caption-text">JADE Developer Guide (TBD):</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../LICENSE.html">License</a></li>
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">Introduction</a></li>
</ul>


Expand Down Expand Up @@ -187,6 +188,9 @@ <h1>Introduction<a class="headerlink" href="#introduction" title="Permalink to t

</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="../publications.html" class="btn btn-neutral float-left" title="List of Publications and Contributions" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div>

<hr/>

Expand Down
3 changes: 2 additions & 1 deletion docs/source/_build/html/testing/testing.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,7 @@
<li class="toctree-l1"><a class="reference internal" href="../usage/folders.html">Folder Structure</a></li>
<li class="toctree-l1"><a class="reference internal" href="../usage/configuration.html">Configuration</a></li>
<li class="toctree-l1"><a class="reference internal" href="../usage/menu.html">Usage</a></li>
<li class="toctree-l1"><a class="reference internal" href="../usage/benchmarks.html">Default Benchmarks</a></li>
<li class="toctree-l1"><a class="reference internal" href="../usage/postprocessing.html">Post-Processing Gallery</a></li>
<li class="toctree-l1"><a class="reference internal" href="../usage/utilities.html">Utilities</a></li>
<li class="toctree-l1"><a class="reference internal" href="../usage/tipstricks.html">Tips &amp; Tricks</a></li>
Expand All @@ -110,7 +111,7 @@
</ul>
<p class="caption"><span class="caption-text">JADE Developer Guide (TBD):</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../LICENSE.html">License</a></li>
<li class="toctree-l1"><a class="reference internal" href="../dev/intro.html">Introduction</a></li>
</ul>


Expand Down
2 changes: 1 addition & 1 deletion docs/source/_build/html/usage/configuration.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@
</ul>
<p class="caption"><span class="caption-text">JADE Developer Guide (TBD):</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../LICENSE.html">License</a></li>
<li class="toctree-l1"><a class="reference internal" href="../dev/intro.html">Introduction</a></li>
</ul>


Expand Down
7 changes: 5 additions & 2 deletions docs/source/_build/html/usage/folders.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/language_data.js"></script>
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
<script type="text/x-mathjax-config">MathJax.Hub.Config({"tex2jax": {"inlineMath": [["\\(", "\\)"]], "displayMath": [["\\[", "\\]"]], "processRefs": false, "processEnvironments": false}})</script>

<script type="text/javascript" src="../_static/js/theme.js"></script>

Expand Down Expand Up @@ -104,9 +106,10 @@
</li>
<li class="toctree-l1"><a class="reference internal" href="configuration.html">Configuration</a></li>
<li class="toctree-l1"><a class="reference internal" href="menu.html">Usage</a></li>
<li class="toctree-l1"><a class="reference internal" href="../benchmarks/benchmarks.html">Default Benchmarks</a></li>
<li class="toctree-l1"><a class="reference internal" href="benchmarks.html">Default Benchmarks</a></li>
<li class="toctree-l1"><a class="reference internal" href="postprocessing.html">Post-Processing Gallery</a></li>
<li class="toctree-l1"><a class="reference internal" href="utilities.html">Utilities</a></li>
<li class="toctree-l1"><a class="reference internal" href="tipstricks.html">Tips &amp; Tricks</a></li>
</ul>
<p class="caption"><span class="caption-text">More on JADE:</span></p>
<ul>
Expand All @@ -117,7 +120,7 @@
</ul>
<p class="caption"><span class="caption-text">JADE Developer Guide (TBD):</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../LICENSE.html">License</a></li>
<li class="toctree-l1"><a class="reference internal" href="../dev/intro.html">Introduction</a></li>
</ul>


Expand Down
2 changes: 1 addition & 1 deletion docs/source/_build/html/usage/installation.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@
</ul>
<p class="caption"><span class="caption-text">JADE Developer Guide (TBD):</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../LICENSE.html">License</a></li>
<li class="toctree-l1"><a class="reference internal" href="../dev/intro.html">Introduction</a></li>
</ul>


Expand Down
11 changes: 7 additions & 4 deletions docs/source/_build/html/usage/menu.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,13 +33,15 @@
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/language_data.js"></script>
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
<script type="text/x-mathjax-config">MathJax.Hub.Config({"tex2jax": {"inlineMath": [["\\(", "\\)"]], "displayMath": [["\\[", "\\]"]], "processRefs": false, "processEnvironments": false}})</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="Default Benchmarks" href="../benchmarks/benchmarks.html" />
<link rel="next" title="Default Benchmarks" href="benchmarks.html" />
<link rel="prev" title="Configuration" href="configuration.html" />
</head>

Expand Down Expand Up @@ -101,9 +103,10 @@
<li class="toctree-l2"><a class="reference internal" href="#post-processing-menu">Post-processing menu</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../benchmarks/benchmarks.html">Default Benchmarks</a></li>
<li class="toctree-l1"><a class="reference internal" href="benchmarks.html">Default Benchmarks</a></li>
<li class="toctree-l1"><a class="reference internal" href="postprocessing.html">Post-Processing Gallery</a></li>
<li class="toctree-l1"><a class="reference internal" href="utilities.html">Utilities</a></li>
<li class="toctree-l1"><a class="reference internal" href="tipstricks.html">Tips &amp; Tricks</a></li>
</ul>
<p class="caption"><span class="caption-text">More on JADE:</span></p>
<ul>
Expand All @@ -114,7 +117,7 @@
</ul>
<p class="caption"><span class="caption-text">JADE Developer Guide (TBD):</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../LICENSE.html">License</a></li>
<li class="toctree-l1"><a class="reference internal" href="../dev/intro.html">Introduction</a></li>
</ul>


Expand Down Expand Up @@ -322,7 +325,7 @@ <h2>Quality check menu<a class="headerlink" href="#quality-check-menu" title="Pe
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="../benchmarks/benchmarks.html" class="btn btn-neutral float-right" title="Default Benchmarks" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="benchmarks.html" class="btn btn-neutral float-right" title="Default Benchmarks" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="configuration.html" class="btn btn-neutral float-left" title="Configuration" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div>

Expand Down
2 changes: 1 addition & 1 deletion docs/source/_build/html/usage/postprocessing.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@
</ul>
<p class="caption"><span class="caption-text">JADE Developer Guide (TBD):</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../LICENSE.html">License</a></li>
<li class="toctree-l1"><a class="reference internal" href="../dev/intro.html">Introduction</a></li>
</ul>


Expand Down
20 changes: 16 additions & 4 deletions docs/source/_build/html/usage/tipstricks.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,12 +33,16 @@
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/language_data.js"></script>
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
<script type="text/x-mathjax-config">MathJax.Hub.Config({"tex2jax": {"inlineMath": [["\\(", "\\)"]], "displayMath": [["\\[", "\\]"]], "processRefs": false, "processEnvironments": false}})</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="search" title="Search" href="../search.html" />
<link rel="next" title="JADE Testing" href="../testing/testing.html" />
<link rel="prev" title="Utilities" href="utilities.html" />
</head>

<body class="wy-body-for-nav">
Expand Down Expand Up @@ -87,15 +91,19 @@


<p class="caption"><span class="caption-text">JADE User Guide:</span></p>
<ul>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../nutshell.html">JADE in a nutshell</a></li>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="folders.html">Folder Structure</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="menu.html">Usage</a></li>
<li class="toctree-l1"><a class="reference internal" href="../benchmarks/benchmarks.html">Default Benchmarks</a></li>
<li class="toctree-l1"><a class="reference internal" href="benchmarks.html">Default Benchmarks</a></li>
<li class="toctree-l1"><a class="reference internal" href="postprocessing.html">Post-Processing Gallery</a></li>
<li class="toctree-l1"><a class="reference internal" href="utilities.html">Utilities</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Tips &amp; Tricks</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#external-run-of-a-benchmark">External Run of a benchmark</a></li>
</ul>
</li>
</ul>
<p class="caption"><span class="caption-text">More on JADE:</span></p>
<ul>
Expand All @@ -106,7 +114,7 @@
</ul>
<p class="caption"><span class="caption-text">JADE Developer Guide (TBD):</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../LICENSE.html">License</a></li>
<li class="toctree-l1"><a class="reference internal" href="../dev/intro.html">Introduction</a></li>
</ul>


Expand Down Expand Up @@ -204,6 +212,10 @@ <h1>Tips &amp; Tricks<a class="headerlink" href="#tips-tricks" title="Permalink

</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="../testing/testing.html" class="btn btn-neutral float-right" title="JADE Testing" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="utilities.html" class="btn btn-neutral float-left" title="Utilities" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div>

<hr/>

Expand Down
4 changes: 2 additions & 2 deletions docs/source/_build/html/usage/utilities.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@
<li class="toctree-l1"><a class="reference internal" href="folders.html">Folder Structure</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="menu.html">Usage</a></li>
<li class="toctree-l1"><a class="reference internal" href="../benchmarks/benchmarks.html">Default Benchmarks</a></li>
<li class="toctree-l1"><a class="reference internal" href="benchmarks.html">Default Benchmarks</a></li>
<li class="toctree-l1"><a class="reference internal" href="postprocessing.html">Post-Processing Gallery</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Utilities</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#print-available-libraries">Print available libraries</a></li>
Expand All @@ -119,7 +119,7 @@
</ul>
<p class="caption"><span class="caption-text">JADE Developer Guide (TBD):</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../LICENSE.html">License</a></li>
<li class="toctree-l1"><a class="reference internal" href="../dev/intro.html">Introduction</a></li>
</ul>


Expand Down

0 comments on commit d1c6c2d

Please sign in to comment.