diff --git a/docs/assignments/ass_overview.md b/docs/api/assignments.md similarity index 100% rename from docs/assignments/ass_overview.md rename to docs/api/assignments.md diff --git a/docs/functions/asabqarray.md b/docs/api/functions/asabqarray.md similarity index 100% rename from docs/functions/asabqarray.md rename to docs/api/functions/asabqarray.md diff --git a/docs/functions/asarray.md b/docs/api/functions/asarray.md similarity index 100% rename from docs/functions/asarray.md rename to docs/api/functions/asarray.md diff --git a/docs/functions/astensor.md b/docs/api/functions/astensor.md similarity index 100% rename from docs/functions/astensor.md rename to docs/api/functions/astensor.md diff --git a/docs/functions/asvoigt.md b/docs/api/functions/asvoigt.md similarity index 100% rename from docs/functions/asvoigt.md rename to docs/api/functions/asvoigt.md diff --git a/docs/functions/determinant.md b/docs/api/functions/determinant.md similarity index 100% rename from docs/functions/determinant.md rename to docs/api/functions/determinant.md diff --git a/docs/functions/deviator.md b/docs/api/functions/deviator.md similarity index 100% rename from docs/functions/deviator.md rename to docs/api/functions/deviator.md diff --git a/docs/functions/identity.md b/docs/api/functions/identity.md similarity index 100% rename from docs/functions/identity.md rename to docs/api/functions/identity.md diff --git a/docs/functions/inverse.md b/docs/api/functions/inverse.md similarity index 100% rename from docs/functions/inverse.md rename to docs/api/functions/inverse.md diff --git a/docs/functions/norm.md b/docs/api/functions/norm.md similarity index 100% rename from docs/functions/norm.md rename to docs/api/functions/norm.md diff --git a/docs/functions/permute.md b/docs/api/functions/permute.md similarity index 100% rename from docs/functions/permute.md rename to docs/api/functions/permute.md diff --git a/docs/functions/piola.md b/docs/api/functions/piola.md similarity index 100% rename from docs/functions/piola.md rename to docs/api/functions/piola.md diff --git a/docs/functions/power.md b/docs/api/functions/power.md similarity index 100% rename from docs/functions/power.md rename to docs/api/functions/power.md diff --git a/docs/functions/rotation.md b/docs/api/functions/rotation.md similarity index 100% rename from docs/functions/rotation.md rename to docs/api/functions/rotation.md diff --git a/docs/functions/squareroot.md b/docs/api/functions/squareroot.md similarity index 100% rename from docs/functions/squareroot.md rename to docs/api/functions/squareroot.md diff --git a/docs/functions/trace.md b/docs/api/functions/trace.md similarity index 100% rename from docs/functions/trace.md rename to docs/api/functions/trace.md diff --git a/docs/functions/transpose.md b/docs/api/functions/transpose.md similarity index 100% rename from docs/functions/transpose.md rename to docs/api/functions/transpose.md diff --git a/docs/functions/unimodular.md b/docs/api/functions/unimodular.md similarity index 100% rename from docs/functions/unimodular.md rename to docs/api/functions/unimodular.md diff --git a/docs/functions/voigtstrain.md b/docs/api/functions/voigtstrain.md similarity index 100% rename from docs/functions/voigtstrain.md rename to docs/api/functions/voigtstrain.md diff --git a/docs/functions.md b/docs/api/index.md similarity index 99% rename from docs/functions.md rename to docs/api/index.md index f8a9d6a..4bb0fc3 100644 --- a/docs/functions.md +++ b/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 b/docs/api/operators/operators_overview.md similarity index 100% rename from docs/operators/operators_overview.md rename to docs/api/operators/operators_overview.md diff --git a/docs/tensordatatypes.md b/docs/api/tensordatatypes.md similarity index 100% rename from docs/tensordatatypes.md rename to docs/api/tensordatatypes.md