docs(tutorial): fix

broken links

docs/conf.py

@@ -9,7 +9,7 @@ sys.path.append('.')
 
 #---- debug mode ----
 # shows/hides the todos
-todo_include_todos = True
+todo_include_todos = False
 
 # -- Project information -----------------------------------------------------
 

docs/format_content/calculation.rst

@@ -12,7 +12,7 @@ A value can be calculated. In this case we have four possibilities:
 - calculation via a variable
 - calculation via an information
 - calculation via a identifier: in a :term:`dynamically built family` returns the current identifier
-- calculation via an index: in the case of a :term:`follower` variable returns the current index
+- calculation via an index: in the case of a follower variable returns the current index
 - calculation via :ref:`the current namespace name <namespace>`
 
 If the user modifies the value of the variable, the default value is no longer used, so the calculation is no longer carried out. This is also the case if the variable has the `auto_save` attribute.
@@ -155,7 +155,7 @@ There are two types of params:
   - parameter via a variable
   - parameter via an information
   - parameter via an identifier: in a :term:`dynamically built family` returns the current identifier
-  - parameter via an index: in the case of a :term:`follower` variable returns the current index
+  - parameter via an index: in the case of a follower variable returns the current index
   - parameter via :ref:`the current namespace name <namespace>`
 
 Variable params

docs/format_content/validation.rst

@@ -75,7 +75,7 @@ There are two types of params:
   - parameter via a variable
   - parameter via an information
   - parameter via an identifier: in a :ref:`dynamically built family <dynamically_built_family>` returns the current identifier
-  - parameter via an index: in the case of a :term:`follower` variable returns the current index
+  - parameter via an index: in the case of a follower variable returns the current index
   - parameter via :ref:`the current namespace name <namespace>`
 
 Variable params

docs/format_content/variable.rst

@@ -174,7 +174,7 @@ Parameters
 
        This value is typed, you must correctly fill out the YAML file to avoid defining a value with an incorrect type. For example, a `integer` must be a digit type, a :term:`multiple <multi>` variable must be a `list` type, ...
 
-       For a non :term:`leading` :term:`multiple <multi>` variable, the first value defined in the list will also be the default value proposed if a new value is added to this variable.
+       For a non leading :term:`multiple <multi>` variable, the first value defined in the list will also be the default value proposed if a new value is added to this variable.
 
        .. seealso:: tutorial with a real world sample :doc:`default parameter <../tutorial/preliminary>`
 
@@ -191,7 +191,7 @@ Parameters
 
        For example, if the value of this variable comes from a calculation, the value will no longer be recalculated.
 
-       These variables are usually :term:`required` variables. In fact, these variables are only automatically modified if they have a value.
+       These variables are usually :term:`required <mandatory>` variables. In fact, these variables are only automatically modified if they have a value.
 
        **Default value**: `false`
 

docs/index.rst

@@ -8,22 +8,6 @@
 Rougail
 ===========
 
-.. todo:: définir les termes suivants:
-
-      4 family.rst:25: WARNING: label non défini: 'convention on variable names'
-      5 structureddata.rst:89: WARNING: term not in glossary: 'variable_namespace'
-      9 variable.rst:38: WARNING: label non défini: 'convention on variable names'
-      11 variable.rst:154: WARNING: term not in glossary: 'required'
-
-
-.. todo:: créer les documents suivants:
-
-      1 rougail/docs/family.rst:102: WARNING: unknown document: 'tutorial/mode'                                                                                                                   
-      3 rougail/docs/structureddata.rst:89: WARNING: term not in glossary: 'variable_namespace'
-      4 rougail/docs/variable.rst:163: WARNING: unknown document: 'tutorial/mode'
-      5 rougail/docs/variable.rst:235: WARNING: unknown document: 'tutorial/validators'
-      6 rougail/docs/variable.rst:263: WARNING: unknown document: 'tutorial/autosave'
-
 .. image:: images/logo.png
 
 - is a `delicious cooked dish <https://fr.wikipedia.org/wiki/Rougail>`_ from the Mauritius and Reunion Islands,

docs/tutorial/index.rst

@@ -72,4 +72,3 @@ Let's dive into this **configuration options validation** use case.
    underscore_parameter
    variable_propertyerror
    redefine
-   whatsnext

docs/tutorial/whatsnext.rst

@@ -1,12 +0,0 @@
-To be continued
-===================
-
-**This tutorial is a work in progress!**
-
-Not all the concepts of rougail are fully explained in this tutorial.
-You can, of course, refer to the rest of the technical documentation, or look at
-the `tutorial's code repository  <https://forge.cloud.silique.fr/stove/rougail-tutorials>`_
-and try to understand the rest of the tutorial steps on your own.
-
-.. note:: Please check again the end of the tutorial section to see if the developers
-          have made any progress in writing it.

docs/user_data/environment.rst

@@ -8,7 +8,7 @@ Synopsis
 
     | Variable values can be defined directly from an environment variable.
     | 
-    | Environnement variable names begin with a prefix (by default ROUGAIL_) followed by the variable path in uppercase, for example: ROUGAIL_MY_VARIABLE. If you are using namespaces, the prefix is the name of the namespace in uppercase.
+    | Environnement variable names begin with a prefix (by default `ROUGAIL_`) followed by the variable path in uppercase, for example: `ROUGAIL_MY_VARIABLE`. If you are using namespaces, the prefix is the name of the namespace in uppercase.
     | 
     | Note that variable paths can contain dots ("."), which are not permitted everywhere. To avoid any issues, use the `env` command, for example: `env ROUGAIL_MY_FAMILY.MY_VARIABLE=1 rougail`.
     |