From 4cad2ce30f551ba4dd46b49795593a7816da212f Mon Sep 17 00:00:00 2001 From: Emmanuel Garette Date: Wed, 10 Jun 2026 22:32:36 +0200 Subject: [PATCH] doc(rename) --- docs/format_content/family.rst | 6 +++--- docs/format_content/variable.rst | 4 ++-- docs/structured_data/documentation.rst | 4 ++-- docs/tutorial/{examples.rst => document.rst} | 0 docs/tutorial/{dynfam.rst => dynamic.rst} | 4 ++-- docs/tutorial/index.rst | 2 +- 6 files changed, 10 insertions(+), 10 deletions(-) rename docs/tutorial/{examples.rst => document.rst} (100%) rename docs/tutorial/{dynfam.rst => dynamic.rst} (99%) diff --git a/docs/format_content/family.rst b/docs/format_content/family.rst index c39e6951e..2f7b6ca2e 100644 --- a/docs/format_content/family.rst +++ b/docs/format_content/family.rst @@ -48,7 +48,7 @@ Parameters `string` - Additional help associated with the family. - .. seealso:: tutorial with a real world sample :doc:`help parameter <../tutorial/examples>` (the tutorial focuses on variable, but the principle is the same for a family) + .. seealso:: tutorial with a real world sample :doc:`help parameter <../tutorial/document>` (the tutorial focuses on variable, but the principle is the same for a family) * - **mode**, **_mode** @@ -186,7 +186,7 @@ Here is a simple example: You can have a look at the tutorial with a real world sample: - :doc:`family <../tutorial/family>` - - :doc:`help parameter <../tutorial/examples>` (the tutorial focuses on variable, but the principle is the same for a family) + - :doc:`help parameter <../tutorial/document>` (the tutorial focuses on variable, but the principle is the same for a family) A dynamically built family ----------------------------- @@ -221,7 +221,7 @@ This will dynamically create two families: .. seealso:: - You can have a look at the tutorial with a real world sample :doc:`dynamically built family <../tutorial/dynfam>` + You can have a look at the tutorial with a real world sample :doc:`dynamically built family <../tutorial/dynamic>` Sequence of homogeneous elements --------------------------------------- diff --git a/docs/format_content/variable.rst b/docs/format_content/variable.rst index f5cb49939..76b8574c5 100644 --- a/docs/format_content/variable.rst +++ b/docs/format_content/variable.rst @@ -74,7 +74,7 @@ Parameters `string` - Additional help associated with the variable. - .. seealso:: tutorial with a real world sample :doc:`help parameter <../tutorial/examples>` + .. seealso:: tutorial with a real world sample :doc:`help parameter <../tutorial/document>` * - **mode** @@ -112,7 +112,7 @@ Parameters `list` - List of examples to illustrate possible values for a variable - .. seealso:: tutorial with a real world sample :doc:`examples parameter <../tutorial/examples>` + .. seealso:: tutorial with a real world sample :doc:`examples parameter <../tutorial/document>` * - **test** diff --git a/docs/structured_data/documentation.rst b/docs/structured_data/documentation.rst index 1679fe174..47a282e2a 100644 --- a/docs/structured_data/documentation.rst +++ b/docs/structured_data/documentation.rst @@ -43,7 +43,7 @@ Help is a property that only concerns documentation. A help helps to clarify any ambiguity about the variable’s purpose. It can be long and detailed. -.. seealso:: tutorial with a real world sample :doc:`help <../tutorial/examples>` +.. seealso:: tutorial with a real world sample :doc:`help <../tutorial/document>` Give examples of possible value ------------------------------- @@ -54,7 +54,7 @@ Don't hesitate to guide the :term:`operator` with relevant examples. Examples is a property that only concerns documentation. -.. seealso:: tutorial with a real world sample :doc:`examples <../tutorial/examples>` +.. seealso:: tutorial with a real world sample :doc:`examples <../tutorial/document>` Specialized variables ----------------------- diff --git a/docs/tutorial/examples.rst b/docs/tutorial/document.rst similarity index 100% rename from docs/tutorial/examples.rst rename to docs/tutorial/document.rst diff --git a/docs/tutorial/dynfam.rst b/docs/tutorial/dynamic.rst similarity index 99% rename from docs/tutorial/dynfam.rst rename to docs/tutorial/dynamic.rst index d07253c52..8a7409db1 100644 --- a/docs/tutorial/dynfam.rst +++ b/docs/tutorial/dynamic.rst @@ -1,4 +1,4 @@ -.. _dynfam: +.. _dynamic: A dynamically built family ========================== @@ -140,7 +140,7 @@ that allow us to define dynamically family names. identifier - In the :ref:`dynamically built family creation field ` we call an identifier + In the :ref:`dynamically built family creation field ` we call an identifier an item that defines a family name. An item is a variable on which an iteration on keywords will be carried out. diff --git a/docs/tutorial/index.rst b/docs/tutorial/index.rst index 378463dcd..b1a45457c 100644 --- a/docs/tutorial/index.rst +++ b/docs/tutorial/index.rst @@ -53,7 +53,7 @@ Let's dive into this **configuration options validation** use case. types calculated properties - dynfam + dynamic jinja customtype nullable