Add tutorials to side bar

Title says it all.
neperfepx · Jan 11, 2024 · 9a5efa2 · 9a5efa2
1 parent 282a591
commit 9a5efa2
Show file tree

Hide file tree

Showing 35 changed files with 161 additions and 288 deletions.
diff --git a/docs/_sources/index.rst.txt b/docs/_sources/index.rst.txt
@@ -21,13 +21,13 @@ FEPX is a finite element software package for polycrystal plasticity. It can mod
 FEPX is currently developed by the Advanced Computational Materials Engineering Laboratory `ACME Lab <https://acmelab.ua.edu>`_ at The University of Alabama, USA, and CNRS, France.
 
 .. toctree::
-    :hidden:
-    :maxdepth: 2
-
-    features.rst
-    doc/index.rst
-    doc/examples.rst
-    papers.rst
-    applications.rst
-    downloads.rst
-    community.rst
+   :hidden:
+   :maxdepth: 2
+
+   features.rst
+   doc/index.rst
+   doc/tutorials.rst
+   papers.rst
+   applications.rst
+   downloads.rst
+   community.rst
diff --git a/docs/applications.html b/docs/applications.html
@@ -43,6 +43,7 @@
               <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="features.html">Features</a></li>
 <li class="toctree-l1"><a class="reference internal" href="doc/index.html">Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="doc/tutorials.html">Tutorials</a></li>
 <li class="toctree-l1"><a class="reference internal" href="papers.html">Reference Papers</a></li>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">Applications</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="#id2">2023</a></li>

diff --git a/docs/community.html b/docs/community.html
@@ -42,6 +42,7 @@
               <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="features.html">Features</a></li>
 <li class="toctree-l1"><a class="reference internal" href="doc/index.html">Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="doc/tutorials.html">Tutorials</a></li>
 <li class="toctree-l1"><a class="reference internal" href="papers.html">Reference Papers</a></li>
 <li class="toctree-l1"><a class="reference internal" href="applications.html">Applications</a></li>
 <li class="toctree-l1"><a class="reference internal" href="downloads.html">Downloads</a></li>

diff --git a/docs/doc/config.html b/docs/doc/config.html
@@ -67,6 +67,7 @@
 <li class="toctree-l2"><a class="reference internal" href="fdl.html">GNU Free Documentation License</a></li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="tutorials.html">Tutorials</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../papers.html">Reference Papers</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../applications.html">Applications</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../downloads.html">Downloads</a></li>

diff --git a/docs/doc/copying.html b/docs/doc/copying.html
@@ -63,6 +63,7 @@
 <li class="toctree-l2"><a class="reference internal" href="fdl.html">GNU Free Documentation License</a></li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="tutorials.html">Tutorials</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../papers.html">Reference Papers</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../applications.html">Applications</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../downloads.html">Downloads</a></li>

diff --git a/docs/doc/crystal.html b/docs/doc/crystal.html
@@ -63,6 +63,7 @@
 <li class="toctree-l2"><a class="reference internal" href="fdl.html">GNU Free Documentation License</a></li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="tutorials.html">Tutorials</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../papers.html">Reference Papers</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../applications.html">Applications</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../downloads.html">Downloads</a></li>

diff --git a/docs/doc/develhistory.html b/docs/doc/develhistory.html
@@ -67,6 +67,7 @@
 <li class="toctree-l2"><a class="reference internal" href="fdl.html">GNU Free Documentation License</a></li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="tutorials.html">Tutorials</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../papers.html">Reference Papers</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../applications.html">Applications</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../downloads.html">Downloads</a></li>

diff --git a/docs/doc/fdl.html b/docs/doc/fdl.html
@@ -59,6 +59,7 @@
 <li class="toctree-l2 current"><a class="current reference internal" href="#">GNU Free Documentation License</a></li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="tutorials.html">Tutorials</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../papers.html">Reference Papers</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../applications.html">Applications</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../downloads.html">Downloads</a></li>

diff --git a/docs/doc/fileformat.html b/docs/doc/fileformat.html
@@ -73,6 +73,7 @@
 <li class="toctree-l2"><a class="reference internal" href="fdl.html">GNU Free Documentation License</a></li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="tutorials.html">Tutorials</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../papers.html">Reference Papers</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../applications.html">Applications</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../downloads.html">Downloads</a></li>

diff --git a/docs/doc/gpl.html b/docs/doc/gpl.html
@@ -59,6 +59,7 @@
 <li class="toctree-l2"><a class="reference internal" href="fdl.html">GNU Free Documentation License</a></li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="tutorials.html">Tutorials</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../papers.html">Reference Papers</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../applications.html">Applications</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../downloads.html">Downloads</a></li>

diff --git a/docs/doc/index.html b/docs/doc/index.html
@@ -59,6 +59,7 @@
 <li class="toctree-l2"><a class="reference internal" href="fdl.html">GNU Free Documentation License</a></li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="tutorials.html">Tutorials</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../papers.html">Reference Papers</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../applications.html">Applications</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../downloads.html">Downloads</a></li>

diff --git a/docs/doc/introduction.html b/docs/doc/introduction.html
@@ -68,6 +68,7 @@
 <li class="toctree-l2"><a class="reference internal" href="fdl.html">GNU Free Documentation License</a></li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="tutorials.html">Tutorials</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../papers.html">Reference Papers</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../applications.html">Applications</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../downloads.html">Downloads</a></li>

diff --git a/docs/doc/loading.html b/docs/doc/loading.html
@@ -70,6 +70,7 @@
 <li class="toctree-l2"><a class="reference internal" href="fdl.html">GNU Free Documentation License</a></li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="tutorials.html">Tutorials</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../papers.html">Reference Papers</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../applications.html">Applications</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../downloads.html">Downloads</a></li>

diff --git a/docs/doc/material.html b/docs/doc/material.html
@@ -81,6 +81,7 @@
 <li class="toctree-l2"><a class="reference internal" href="fdl.html">GNU Free Documentation License</a></li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="tutorials.html">Tutorials</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../papers.html">Reference Papers</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../applications.html">Applications</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../downloads.html">Downloads</a></li>

diff --git a/docs/doc/output.html b/docs/doc/output.html
@@ -66,6 +66,7 @@
 <li class="toctree-l2"><a class="reference internal" href="fdl.html">GNU Free Documentation License</a></li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="tutorials.html">Tutorials</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../papers.html">Reference Papers</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../applications.html">Applications</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../downloads.html">Downloads</a></li>

diff --git a/docs/doc/running.html b/docs/doc/running.html
@@ -68,6 +68,7 @@
 <li class="toctree-l2"><a class="reference internal" href="fdl.html">GNU Free Documentation License</a></li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="tutorials.html">Tutorials</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../papers.html">Reference Papers</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../applications.html">Applications</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../downloads.html">Downloads</a></li>

diff --git a/docs/doc/tutorials.html b/docs/doc/tutorials.html
@@ -42,32 +42,17 @@
         </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
               <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="../features.html">Features</a></li>
-<li class="toctree-l1 current"><a class="reference internal" href="index.html">Documentation</a><ul class="current">
-<li class="toctree-l2"><a class="reference internal" href="copying.html">Conditions of Use</a></li>
-<li class="toctree-l2"><a class="reference internal" href="introduction.html">Introduction</a></li>
-<li class="toctree-l2"><a class="reference internal" href="config.html">Configuration File (<code class="file docutils literal notranslate"><span class="pre">simulation.cfg</span></code>)</a></li>
-<li class="toctree-l2"><a class="reference internal" href="material.html">Crystal Behavior (<code class="file docutils literal notranslate"><span class="pre">simulation.cfg</span></code>)</a></li>
-<li class="toctree-l2"><a class="reference internal" href="loading.html">Loading (<code class="file docutils literal notranslate"><span class="pre">simulation.cfg</span></code>)</a></li>
-<li class="toctree-l2"><a class="reference internal" href="output.html">Simulation Results (<code class="file docutils literal notranslate"><span class="pre">simulation.cfg</span></code>)</a></li>
-<li class="toctree-l2"><a class="reference internal" href="running.html">Convergence Parameters (<code class="file docutils literal notranslate"><span class="pre">simulation.cfg</span></code>)</a></li>
-<li class="toctree-l2"><a class="reference internal" href="crystal.html">Crystal Structures</a></li>
-<li class="toctree-l2"><a class="reference internal" href="fileformat.html">File and Directory Formats</a></li>
-<li class="toctree-l2 current"><a class="current reference internal" href="#">Tutorials</a><ul>
-<li class="toctree-l3"><a class="reference internal" href="tutorials/simple_simulation.html">Simple Simulation</a></li>
-<li class="toctree-l3"><a class="reference internal" href="tutorials/simple_rve_simulation.html">Simple RVE-type Simulation</a></li>
-<li class="toctree-l3"><a class="reference internal" href="tutorials/periodic_rve_simulation.html">Periodic RVE-type Simulation</a></li>
-<li class="toctree-l3"><a class="reference internal" href="tutorials/cruciform_specimen_simulation.html">Cruciform Specimen Simulation</a></li>
-<li class="toctree-l3"><a class="reference internal" href="tutorials/overwriting.html">Overwrting Polycrystal Attributes</a></li>
-<li class="toctree-l3"><a class="reference internal" href="tutorials/hpc.html">Submitting FEPX to a Job Scheduling Program</a></li>
-<li class="toctree-l3"><a class="reference internal" href="tutorials/restart.html">[LEGACY] Restarting a Simulation with Appended Load Steps</a></li>
-<li class="toctree-l3"><a class="reference internal" href="tutorials/multiaxial_csr.html">[LEGACY] Multiaxial Control with Constant Strain Rate</a></li>
-<li class="toctree-l3"><a class="reference internal" href="tutorials/multiaxial_clr.html">[LEGACY] Multiaxial Control with Constant Load Rate</a></li>
-</ul>
-</li>
-<li class="toctree-l2"><a class="reference internal" href="versions.html">Versions</a></li>
-<li class="toctree-l2"><a class="reference internal" href="develhistory.html">Development History (1990-2020)</a></li>
-<li class="toctree-l2"><a class="reference internal" href="gpl.html">GNU General Public License</a></li>
-<li class="toctree-l2"><a class="reference internal" href="fdl.html">GNU Free Documentation License</a></li>
+<li class="toctree-l1"><a class="reference internal" href="index.html">Documentation</a></li>
+<li class="toctree-l1 current"><a class="current reference internal" href="#">Tutorials</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="tutorials/simple_simulation.html">Simple Simulation</a></li>
+<li class="toctree-l2"><a class="reference internal" href="tutorials/simple_rve_simulation.html">Simple RVE-type Simulation</a></li>
+<li class="toctree-l2"><a class="reference internal" href="tutorials/periodic_rve_simulation.html">Periodic RVE-type Simulation</a></li>
+<li class="toctree-l2"><a class="reference internal" href="tutorials/cruciform_specimen_simulation.html">Cruciform Specimen Simulation</a></li>
+<li class="toctree-l2"><a class="reference internal" href="tutorials/overwriting.html">Overwrting Polycrystal Attributes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="tutorials/hpc.html">Submitting FEPX to a Job Scheduling Program</a></li>
+<li class="toctree-l2"><a class="reference internal" href="tutorials/restart.html">[LEGACY] Restarting a Simulation with Appended Load Steps</a></li>
+<li class="toctree-l2"><a class="reference internal" href="tutorials/multiaxial_csr.html">[LEGACY] Multiaxial Control with Constant Strain Rate</a></li>
+<li class="toctree-l2"><a class="reference internal" href="tutorials/multiaxial_clr.html">[LEGACY] Multiaxial Control with Constant Load Rate</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="../papers.html">Reference Papers</a></li>

diff --git a/docs/doc/tutorials/cruciform_specimen_simulation.html b/docs/doc/tutorials/cruciform_specimen_simulation.html
@@ -43,36 +43,21 @@
         </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
               <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="../../features.html">Features</a></li>
-<li class="toctree-l1 current"><a class="reference internal" href="../index.html">Documentation</a><ul class="current">
-<li class="toctree-l2"><a class="reference internal" href="../copying.html">Conditions of Use</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../introduction.html">Introduction</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../config.html">Configuration File (<code class="file docutils literal notranslate"><span class="pre">simulation.cfg</span></code>)</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../material.html">Crystal Behavior (<code class="file docutils literal notranslate"><span class="pre">simulation.cfg</span></code>)</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../loading.html">Loading (<code class="file docutils literal notranslate"><span class="pre">simulation.cfg</span></code>)</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../output.html">Simulation Results (<code class="file docutils literal notranslate"><span class="pre">simulation.cfg</span></code>)</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../running.html">Convergence Parameters (<code class="file docutils literal notranslate"><span class="pre">simulation.cfg</span></code>)</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../crystal.html">Crystal Structures</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../fileformat.html">File and Directory Formats</a></li>
-<li class="toctree-l2 current"><a class="reference internal" href="../tutorials.html">Tutorials</a><ul class="current">
-<li class="toctree-l3"><a class="reference internal" href="simple_simulation.html">Simple Simulation</a></li>
-<li class="toctree-l3"><a class="reference internal" href="simple_rve_simulation.html">Simple RVE-type Simulation</a></li>
-<li class="toctree-l3"><a class="reference internal" href="periodic_rve_simulation.html">Periodic RVE-type Simulation</a></li>
-<li class="toctree-l3 current"><a class="current reference internal" href="#">Cruciform Specimen Simulation</a><ul>
-<li class="toctree-l4"><a class="reference internal" href="#equal-biaxial">Equal Biaxial</a></li>
-<li class="toctree-l4"><a class="reference internal" href="#general-biaxial">General Biaxial</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../index.html">Documentation</a></li>
+<li class="toctree-l1 current"><a class="reference internal" href="../tutorials.html">Tutorials</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="simple_simulation.html">Simple Simulation</a></li>
+<li class="toctree-l2"><a class="reference internal" href="simple_rve_simulation.html">Simple RVE-type Simulation</a></li>
+<li class="toctree-l2"><a class="reference internal" href="periodic_rve_simulation.html">Periodic RVE-type Simulation</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="#">Cruciform Specimen Simulation</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="#equal-biaxial">Equal Biaxial</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#general-biaxial">General Biaxial</a></li>
 </ul>
 </li>
-<li class="toctree-l3"><a class="reference internal" href="overwriting.html">Overwrting Polycrystal Attributes</a></li>
-<li class="toctree-l3"><a class="reference internal" href="hpc.html">Submitting FEPX to a Job Scheduling Program</a></li>
-<li class="toctree-l3"><a class="reference internal" href="restart.html">[LEGACY] Restarting a Simulation with Appended Load Steps</a></li>
-<li class="toctree-l3"><a class="reference internal" href="multiaxial_csr.html">[LEGACY] Multiaxial Control with Constant Strain Rate</a></li>
-<li class="toctree-l3"><a class="reference internal" href="multiaxial_clr.html">[LEGACY] Multiaxial Control with Constant Load Rate</a></li>
-</ul>
-</li>
-<li class="toctree-l2"><a class="reference internal" href="../versions.html">Versions</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../develhistory.html">Development History (1990-2020)</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../gpl.html">GNU General Public License</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../fdl.html">GNU Free Documentation License</a></li>
+<li class="toctree-l2"><a class="reference internal" href="overwriting.html">Overwrting Polycrystal Attributes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="hpc.html">Submitting FEPX to a Job Scheduling Program</a></li>
+<li class="toctree-l2"><a class="reference internal" href="restart.html">[LEGACY] Restarting a Simulation with Appended Load Steps</a></li>
+<li class="toctree-l2"><a class="reference internal" href="multiaxial_csr.html">[LEGACY] Multiaxial Control with Constant Strain Rate</a></li>
+<li class="toctree-l2"><a class="reference internal" href="multiaxial_clr.html">[LEGACY] Multiaxial Control with Constant Load Rate</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="../../papers.html">Reference Papers</a></li>