Move API docs

adtzlr · Sep 26, 2023 · 9f72947 · 9f72947
1 parent 864650f
commit 9f72947
Show file tree

Hide file tree

Showing 22 changed files with 2 additions and 1 deletion.
diff --git a/docs/assignments/ass_overview.md → docs/api/assignments.md b/docs/assignments/ass_overview.md → docs/api/assignments.md
diff --git a/docs/functions/asabqarray.md → docs/api/functions/asabqarray.md b/docs/functions/asabqarray.md → docs/api/functions/asabqarray.md
diff --git a/docs/functions/asarray.md → docs/api/functions/asarray.md b/docs/functions/asarray.md → docs/api/functions/asarray.md
diff --git a/docs/functions/astensor.md → docs/api/functions/astensor.md b/docs/functions/astensor.md → docs/api/functions/astensor.md
diff --git a/docs/functions/asvoigt.md → docs/api/functions/asvoigt.md b/docs/functions/asvoigt.md → docs/api/functions/asvoigt.md
diff --git a/docs/functions/determinant.md → docs/api/functions/determinant.md b/docs/functions/determinant.md → docs/api/functions/determinant.md
diff --git a/docs/functions/deviator.md → docs/api/functions/deviator.md b/docs/functions/deviator.md → docs/api/functions/deviator.md
diff --git a/docs/functions/identity.md → docs/api/functions/identity.md b/docs/functions/identity.md → docs/api/functions/identity.md
diff --git a/docs/functions/inverse.md → docs/api/functions/inverse.md b/docs/functions/inverse.md → docs/api/functions/inverse.md
diff --git a/docs/functions/norm.md → docs/api/functions/norm.md b/docs/functions/norm.md → docs/api/functions/norm.md
diff --git a/docs/functions/permute.md → docs/api/functions/permute.md b/docs/functions/permute.md → docs/api/functions/permute.md
diff --git a/docs/functions/piola.md → docs/api/functions/piola.md b/docs/functions/piola.md → docs/api/functions/piola.md
diff --git a/docs/functions/power.md → docs/api/functions/power.md b/docs/functions/power.md → docs/api/functions/power.md
diff --git a/docs/functions/rotation.md → docs/api/functions/rotation.md b/docs/functions/rotation.md → docs/api/functions/rotation.md
diff --git a/docs/functions/squareroot.md → docs/api/functions/squareroot.md b/docs/functions/squareroot.md → docs/api/functions/squareroot.md
diff --git a/docs/functions/trace.md → docs/api/functions/trace.md b/docs/functions/trace.md → docs/api/functions/trace.md
diff --git a/docs/functions/transpose.md → docs/api/functions/transpose.md b/docs/functions/transpose.md → docs/api/functions/transpose.md
diff --git a/docs/functions/unimodular.md → docs/api/functions/unimodular.md b/docs/functions/unimodular.md → docs/api/functions/unimodular.md
diff --git a/docs/functions/voigtstrain.md → docs/api/functions/voigtstrain.md b/docs/functions/voigtstrain.md → docs/api/functions/voigtstrain.md
diff --git a/docs/functions.md → docs/api/index.md b/docs/functions.md → docs/api/index.md
@@ -2,6 +2,7 @@
 title: API Reference
 layout: page
 nav_order: 3
+has_children: true
 ---
 
 ## Module Function Overview
@@ -19,7 +20,7 @@ To ensure consistency in calculating the virtual work shear terms are treated di
 All tensors, whether they are "stress"- or "strain"-like are stored with original (**no doubled**) shear components. Instead all dot- and double-dot-products are modified to take virtual work consistency into account. To be more precise, the function `asvoigt` is not really a Voigt storage - it is more a synonym for storing symmetric tensors as vectors and matrices. The user does have to take care of that storage if the strain in a user subroutine is used as an input for a `Tensor2s` data type and divide all shear components by a factor of `2`.
 
 ### Assignments
-- [General behaviour of data type conversion]({% link assignments/ass_overview.md %})
+- [General behaviour of data type conversion]({% link assignments.md %})
 
 ### Operators
 - [Dot Product]({% link operators/operators_overview.md %})

diff --git a/docs/operators/operators_overview.md → docs/api/operators/operators_overview.md b/docs/operators/operators_overview.md → docs/api/operators/operators_overview.md
diff --git a/docs/tensordatatypes.md → docs/api/tensordatatypes.md b/docs/tensordatatypes.md → docs/api/tensordatatypes.md