Put tutorials into a subsection

DorianDepriester · Dec 6, 2024 · 46c0e06 · 46c0e06
1 parent 03c69fe
commit 46c0e06
Show file tree

Hide file tree

Showing 6 changed files with 23 additions and 19 deletions.
diff --git a/docs/source/Tutorial_AveragingMethods.rst b/docs/source/Tutorial_AveragingMethods.rst
@@ -1,5 +1,5 @@
-Tutorial: Averaging methods
----------------------------
+Averaging methods
+-----------------
 
 This tutorial explains how to compute the Voigt, Reuss and Hill averages from a given stiffness tensor and a finite or
 an infinite set of rotations.

diff --git a/docs/source/example_StiffnessTensor.rst → docs/source/Tutorial_StiffnessTensor.rst b/docs/source/example_StiffnessTensor.rst → docs/source/Tutorial_StiffnessTensor.rst
@@ -1,9 +1,7 @@
-Tutorial: extracting elasticity constants from the stiffness tensor
-===================================================================
+Extracting engineering constants from the stiffness tensor
+==========================================================
 
 
-Introduction
-------------
 This page illustrates how one can create stiffness (or compliance) tensors, manipulate them and plot some
 elasticity-related values (e.g. Young modulus).
 
@@ -94,7 +92,7 @@ In order to fully evidence the directional dependence of the Young moduli, we ca
         :width: 400
 
 It is advised to use interactive plot to be able to zoom/rotate the surface. For flat images (i.e. to put in
-document/articles), we can use plot the values as a Pole Figure (PF):
+document/articles), we can plot the values as a Pole Figure (PF):
 
     >>> E.plot_as_pole_figure() # doctest: +SKIP
 

diff --git a/docs/source/example_StressStrain.rst → docs/source/Tutorial_StressStrain.rst b/docs/source/example_StressStrain.rst → docs/source/Tutorial_StressStrain.rst
@@ -1,8 +1,6 @@
-Tutorial: working with stress and strain tensors
-========================================================
+Working with stress and strain tensors
+======================================
 
-Introduction
-------------
 This tutorial illustrates how we work on strain and stress tensors, and how Elasticipy handles arrays of tensors.
 
 Single tensors
@@ -202,4 +200,4 @@ Which yields the same results in terms of stress:
      [ 8.22419895e+01 -4.88440590e-01 -1.52733598e-01]
      [ 2.02619662e-01 -1.52733598e-01 -4.66942413e-02]]
 
-See :ref:`here<Tutorial: Averaging methods>` for further details about the averaging methods.
+See :ref:`here<Averaging methods>` for further details about the averaging methods.
diff --git a/docs/source/Tutorial_wave-velocities.rst b/docs/source/Tutorial_wave-velocities.rst
@@ -1,5 +1,5 @@
-Tutorial: computing wave velocities
-===================================
+Computing wave velocities
+=========================
 
 In this tutorial, we will see how one can compute the wave velocities in an (an)isotropic material, given its stiffness
 tensor and its mass density.
@@ -67,3 +67,4 @@ Now, we can plot all the velocities on three independent pole figures:
     We pass ``subplot_args`` to create the subplots. The option ``show=false`` temporary disables showing the figure;
     this is necessary here to be plot multiple figures at once.
 
+For further details about plotting options, see :ref:`here<plotting>`.
diff --git a/docs/source/Tutorials.rst b/docs/source/Tutorials.rst
@@ -0,0 +1,11 @@
+Tutorials
+---------
+.. toctree::
+    :maxdepth: 2
+    :caption: Table of Contents
+
+    ./GUI.rst
+    ./Tutorial_StressStrain.rst
+    ./Tutorial_StiffnessTensor.rst
+    ./Tutorial_AveragingMethods.rst
+    ./Tutorial_wave-velocities.rst
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -138,9 +138,5 @@ To install this package, simply run::
    :maxdepth: 2
    :caption: Table of Contents
 
-   ./GUI.rst
-   ./example_StressStrain.rst
-   ./example_StiffnessTensor.rst
-   ./Tutorial_AveragingMethods.rst
-   ./Tutorial_wave-velocities.rst
+   ./Tutorials.rst
    modules