fix: documentation

This commit is contained in:
egarette@silique.fr 2025-12-22 15:35:53 +01:00
parent bad47893d0
commit fe66316e9c
6 changed files with 94 additions and 89 deletions

View file

@ -5,7 +5,7 @@ include_toc: true
[🇬🇧 (EN)](README.md) - [🇫🇷 (FR)](README.fr.md)
| Variable | Description | Valeur par défaut | Type | Contrôle des accès | Validateur |
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------|----------------------|----------------------------------------------------------------------------------------------------------------------------------------------------|
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------|----------------------|----------------------------------------------------------------------------------------------------------------------------------------------------|
| **<a id="default_structural_format_version" name="default_structural_format_version">default_structural_format_version</a>**<br/>**Ligne de commande** : -v, --default_structural_format_version<br/>**Variable d'environnement** : DEFAULT_STRUCTURAL_FORMAT_VERSION | Version par défaut du format des fichiers de structure.<br/>Cette valeur n&#x27;est utilisée que si la version n&#x27;est pas définie dans le fichier de structure. | | [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) | `standard` | **Choix** : <br/>&nbsp;1.0<br/>&nbsp;1.1<br/>&nbsp;null |
| **<a id="functions_files" name="functions_files">functions_files</a>**<br/>**Ligne de commande** : -c, --functions_files<br/>**Variable d'environnement** : FUNCTIONS_FILES | Fichier avec les fonctions.<br/>Ce fichier contient des filtres et des fonctions Jinja2 supplémentaires utilisables dans les fichiers de structure. | | [`UNIX filename`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` | `standard` | `unique`<br/>&nbsp;le nom de fichier peut être une chemin relatif<br/>&nbsp;le fichier doit exister<br/>&nbsp;type de fichier autorisé: "file". |
| **<a id="modes_level" name="modes_level">modes_level</a>**<br/>**Ligne de commande** : --modes_level<br/>**Variable d'environnement** : MODES_LEVEL | Tous les niveaux de modes valides. | | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` | `standard` | `unique` |
@ -13,7 +13,7 @@ include_toc: true
| **<a id="default_variable_mode" name="default_variable_mode">default_variable_mode</a>**<br/>**Variable d'environnement** : DEFAULT_VARIABLE_MODE | Mode par défaut pour une variable. | si la variable "[Tous les niveaux de modes valides](#modes_level)" est définit, la valeur par défaut est le second élément disponible, sinon, le premier | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) | `standard` | Ce mode doit être disponible dans "[Tous les niveaux de modes valides](#modes_level)". |
| **<a id="base_option_name" name="base_option_name">base_option_name</a>**<br/>**Variable d'environnement** : BASE_OPTION_NAME | Nom de l&#x27;option pour l&#x27;option de base. | baseoption | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) | `standard` | |
| **<a id="export_with_import" name="export_with_import">export_with_import</a>**<br/>**Variable d'environnement** : EXPORT_WITH_IMPORT | Dans le fichier de cache, ne pas importer Tiramisu et autres dépendances. | true | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) | `standard` | |
| **<a id="tiramisu_cache" name="tiramisu_cache">tiramisu_cache</a>**<br/>**Ligne de commande** : -t, --tiramisu_cache<br/>**Variable d'environnement** : TIRAMISU_CACHE | Store Tiramisu cache filename.<br/>Ce fichier contient les instructions Tiramisu utilisé en interne pour charger les variables.<br/>Ce fichier peut être utilisé pour le débogage. | | [`UNIX filename`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) | `standard` | •&nbsp;le nom de fichier peut être une chemin relatif<br/>&nbsp;type de fichier autorisé: "file". |
| **<a id="tiramisu_cache" name="tiramisu_cache">tiramisu_cache</a>**<br/>**Ligne de commande** : -t, --tiramisu_cache<br/>**Variable d'environnement** : TIRAMISU_CACHE | Enregistrer le cache Tiramisu dans le fichier.<br/>Ce fichier contient les instructions Tiramisu utilisé en interne pour charger les variables.<br/>Ce fichier peut être utilisé pour le débogage. | | [`UNIX filename`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) | `standard` | •&nbsp;le nom de fichier peut être une chemin relatif<br/>&nbsp;type de fichier autorisé: "file". |
| **<a id="internal_functions" name="internal_functions">internal_functions</a>**<br/>**Variable d'environnement** : INTERNAL_FUNCTIONS | Nom des fonctions internes qu&#x27;il est possible d&#x27;utiliser comme fonction. | | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` | `standard` | |
| **<a id="extra_annotators" name="extra_annotators">extra_annotators</a>**<br/>**Variable d'environnement** : EXTRA_ANNOTATORS | Nom des annotators supplémentaires. | | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` | `standard` | |
| **<a id="suffix" name="suffix">suffix</a>**<br/>**Variable d'environnement** : SUFFIX | Suffix ajouté pour généré le nom des options. | | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) | `standard` | |
@ -39,9 +39,9 @@ include_toc: true
> `standard`
| Variable | Description | Valeur par défaut | Type | Contrôle des accès | Validateur |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------|---------------------|--------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------|---------------------|--------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **<a id="step.structural" name="step.structural">step.structural</a>**<br/>**Variable d'environnement** : STEP.STRUCTURAL | Sélection pour structure. | •&nbsp;directory | [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` | `standard` | **Choix** : <br/>&nbsp;directory<br/>&nbsp;string<br/>&nbsp;commandline<br/>&nbsp;risotto<br/>&nbsp;bitwarden |
| **<a id="step.user_data" name="step.user_data">step.user_data</a>**<br/>**Ligne de commande** : -u, --step.user_data<br/>**Variable d'environnement** : STEP.USER_DATA | Sélection pour données utilisateur. | | [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` | `standard` *`désactivé`*<br/>**Désactivé** : _('cannot load user data for doc output') | `unique`<br/>**Choix** : <br/>&nbsp;yaml<br/>&nbsp;environment<br/>&nbsp;commandline<br/>&nbsp;ansible<br/>&nbsp;questionary<br/>&nbsp;risotto<br/>&nbsp;bitwarden |
| **<a id="step.user_data" name="step.user_data">step.user_data</a>**<br/>**Ligne de commande** : -u, --step.user_data<br/>**Variable d'environnement** : STEP.USER_DATA | Sélection pour données utilisateur. | | [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` | `standard` *`désactivé`*<br/>**Désactivé** : les sorties "doc" n'autorisent pas des données utilisateur | `unique`<br/>**Choix** : <br/>&nbsp;yaml<br/>&nbsp;environment<br/>&nbsp;commandline<br/>&nbsp;ansible<br/>&nbsp;questionary<br/>&nbsp;risotto<br/>&nbsp;bitwarden |
| **<a id="step.output" name="step.output">step.output</a>**<br/>**Ligne de commande** : -o, --step.output<br/>**Variable d'environnement** : STEP.OUTPUT | Sélection pour sortie. | display | [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | `standard` | **Choix** : <br/>&nbsp;display<br/>&nbsp;json<br/>&nbsp;doc<br/>&nbsp;table<br/>&nbsp;ansible |
| Variable | Description | Valeur par défaut | Type | Contrôle des accès |

View file

@ -39,9 +39,9 @@ include_toc: true
> `standard`
| Variable | Description | Default value | Type | Access control | Validator |
|-------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------|------------------|------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|-------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------|------------------|------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **<a id="step.structural" name="step.structural">step.structural</a>**<br/>**Environment variable**: STEP.STRUCTURAL | Select for structural. | •&nbsp;directory | [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` | `standard` | **Choices**: <br/>&nbsp;directory<br/>&nbsp;string<br/>&nbsp;commandline<br/>&nbsp;risotto<br/>&nbsp;bitwarden |
| **<a id="step.user_data" name="step.user_data">step.user_data</a>**<br/>**Command line**: -u, --step.user_data<br/>**Environment variable**: STEP.USER_DATA | Select for user datas. | | [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` | `standard` *`disabled`*<br/>**Disabled**: _('cannot load user data for doc output') | `unique`<br/>**Choices**: <br/>&nbsp;yaml<br/>&nbsp;environment<br/>&nbsp;commandline<br/>&nbsp;ansible<br/>&nbsp;questionary<br/>&nbsp;risotto<br/>&nbsp;bitwarden |
| **<a id="step.user_data" name="step.user_data">step.user_data</a>**<br/>**Command line**: -u, --step.user_data<br/>**Environment variable**: STEP.USER_DATA | Select for user datas. | | [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` | `standard` *`disabled`*<br/>**Disabled**: outputs "doc" did not allow user data | `unique`<br/>**Choices**: <br/>&nbsp;yaml<br/>&nbsp;environment<br/>&nbsp;commandline<br/>&nbsp;ansible<br/>&nbsp;questionary<br/>&nbsp;risotto<br/>&nbsp;bitwarden |
| **<a id="step.output" name="step.output">step.output</a>**<br/>**Command line**: -o, --step.output<br/>**Environment variable**: STEP.OUTPUT | Select for output. | display | [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | `standard` | **Choices**: <br/>&nbsp;display<br/>&nbsp;json<br/>&nbsp;doc<br/>&nbsp;table<br/>&nbsp;ansible |
| Variable | Description | Default value | Type | Access control |

View file

@ -5,8 +5,8 @@
msgid ""
msgstr ""
"Project-Id-Version: \n"
"POT-Creation-Date: 2025-12-22 08:45+0100\n"
"PO-Revision-Date: 2025-12-22 08:46+0100\n"
"POT-Creation-Date: 2025-12-22 15:32+0100\n"
"PO-Revision-Date: 2025-12-22 15:35+0100\n"
"Last-Translator: \n"
"Language-Team: \n"
"Language: fr\n"
@ -185,22 +185,22 @@ msgid ""
msgstr ""
"la variable \"{0}\" a la valeur par défaut invalide \"{1}\" devrait être {2}"
#: src/rougail/config/__init__.py:271
#: src/rougail/config/__init__.py:272
msgid "Default version of the structural file format"
msgstr "Version par défaut du format des fichiers de structure"
#: src/rougail/config/__init__.py:272
#: src/rougail/config/__init__.py:273
msgid ""
"This value is only used if the version is not set in the structural file"
msgstr ""
"Cette valeur n'est utilisée que si la version n'est pas définie dans le "
"fichier de structure"
#: src/rougail/config/__init__.py:280
#: src/rougail/config/__init__.py:281
msgid "File with functions"
msgstr "Fichier avec les fonctions"
#: src/rougail/config/__init__.py:281
#: src/rougail/config/__init__.py:282
msgid ""
"This file contains filters and additional Jinja2 functions usable in "
"structure files"
@ -208,31 +208,31 @@ msgstr ""
"Ce fichier contient des filtres et des fonctions Jinja2 supplémentaires "
"utilisables dans les fichiers de structure"
#: src/rougail/config/__init__.py:293
#: src/rougail/config/__init__.py:294
msgid "All modes level available"
msgstr "Tous les niveaux de modes valides"
#: src/rougail/config/__init__.py:305
#: src/rougail/config/__init__.py:306
msgid "Default mode for a family"
msgstr "Mode par défaut pour une famille"
#: src/rougail/config/__init__.py:311
#: src/rougail/config/__init__.py:312
msgid "the first one defined in \"modes_level\""
msgstr "le premier défini dans \"modes_level\""
#: src/rougail/config/__init__.py:317 src/rougail/config/__init__.py:344
#: src/rougail/config/__init__.py:318 src/rougail/config/__init__.py:345
msgid "when no mode is defined in \"modes_level\""
msgstr "si aucun mode n'est défini dans \"modes_level\""
#: src/rougail/config/__init__.py:324 src/rougail/config/__init__.py:351
#: src/rougail/config/__init__.py:325 src/rougail/config/__init__.py:352
msgid "this mode must be available in \"modes_level\""
msgstr "ce mode doit être disponible dans \"modes_level\""
#: src/rougail/config/__init__.py:328
#: src/rougail/config/__init__.py:329
msgid "Default mode for a variable"
msgstr "Mode par défaut pour une variable"
#: src/rougail/config/__init__.py:338
#: src/rougail/config/__init__.py:339
msgid ""
"if the variable \"modes_level\" is defined, the default value is the second "
"available element, otherwise, the first"
@ -240,22 +240,20 @@ msgstr ""
"si la variable \"modes_level\" est définit, la valeur par défaut est le "
"second élément disponible, sinon, le premier"
#: src/rougail/config/__init__.py:355
#: src/rougail/config/__init__.py:356
msgid "Option name for the base option"
msgstr "Nom de l'option pour l'option de base"
#: src/rougail/config/__init__.py:360
#: src/rougail/config/__init__.py:361
msgid "In cache file, do not importation of Tiramisu and other dependencies"
msgstr ""
"Dans le fichier de cache, ne pas importer Tiramisu et autres dépendances"
#: src/rougail/config/__init__.py:365
#, fuzzy
#| msgid "Store tiramisu cache filename"
#: src/rougail/config/__init__.py:366
msgid "Store Tiramisu cache filename"
msgstr "Enregistrer le cache Tiramisu dans le fichier"
#: src/rougail/config/__init__.py:366
#: src/rougail/config/__init__.py:367
msgid ""
"This file contains the Tiramisu instructions used internally to load the "
"variables.\n"
@ -267,32 +265,32 @@ msgstr ""
"\n"
"Ce fichier peut être utilisé pour le débogage."
#: src/rougail/config/__init__.py:376
#: src/rougail/config/__init__.py:377
msgid "Name of internal functions that we can use as a function"
msgstr ""
"Nom des fonctions internes qu'il est possible d'utiliser comme fonction"
#: src/rougail/config/__init__.py:382
#: src/rougail/config/__init__.py:383
msgid "Name of extra annotators"
msgstr "Nom des annotators supplémentaires"
#: src/rougail/config/__init__.py:388
#: src/rougail/config/__init__.py:389
msgid "Suffix add to generated options name"
msgstr "Suffix ajouté pour généré le nom des options"
#: src/rougail/config/__init__.py:394
#: src/rougail/config/__init__.py:395
msgid "Every variables in calculation are optionals"
msgstr "Toutes les variables dans un calcul sont optionnelles"
#: src/rougail/config/__init__.py:398
#: src/rougail/config/__init__.py:399
msgid "Loads redefine variables even if there don't already exists"
msgstr "Charger les variables redéfinis même si elles n'existe pas"
#: src/rougail/config/__init__.py:402
#: src/rougail/config/__init__.py:403
msgid "The secret manager"
msgstr "Le gestionnaire de secret"
#: src/rougail/config/__init__.py:405
#: src/rougail/config/__init__.py:406
msgid ""
"The secret pattern to constructing the name of the item searched for in the "
"secret manager"
@ -300,31 +298,35 @@ msgstr ""
"Le modèle de secret permettant de construire le nom de l'élément recherché "
"dans le gestionnaire de secrets"
#: src/rougail/config/__init__.py:406
#: src/rougail/config/__init__.py:407
msgid "The pattern is in Jinja2 format"
msgstr "Le modèle est au format Jinja2"
#: src/rougail/config/__init__.py:415
#: src/rougail/config/__init__.py:416
msgid "structural"
msgstr "structure"
#: src/rougail/config/__init__.py:416
#: src/rougail/config/__init__.py:417
msgid "user datas"
msgstr "données utilisateur"
#: src/rougail/config/__init__.py:417
#: src/rougail/config/__init__.py:418
msgid "output"
msgstr "sortie"
#: src/rougail/config/__init__.py:438
#: src/rougail/config/__init__.py:439
msgid "Select for {0}"
msgstr "Sélection pour {0}"
#: src/rougail/config/__init__.py:500
#: src/rougail/config/__init__.py:477
msgid "outputs {0} did not allow user data"
msgstr "les sorties {0} n'autorisent pas des données utilisateur"
#: src/rougail/config/__init__.py:503
msgid "Override default parameters for option type"
msgstr "Sur charger les paramètre par défaut pour le type d'option"
#: src/rougail/config/__init__.py:503
#: src/rougail/config/__init__.py:506
msgid "Default parameters for option type"
msgstr "Paramètre par défaut pour le type d'option"

View file

@ -5,7 +5,7 @@
msgid ""
msgstr ""
"Project-Id-Version: PACKAGE VERSION\n"
"POT-Creation-Date: 2025-12-22 08:46+0100\n"
"POT-Creation-Date: 2025-12-22 15:35+0100\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\n"
@ -127,122 +127,126 @@ msgstr ""
msgid "the variable \"{0}\" has an unvalid default value \"{1}\" should be in {2}"
msgstr ""
#: src/rougail/config/__init__.py:271
#: src/rougail/config/__init__.py:272
msgid "Default version of the structural file format"
msgstr ""
#: src/rougail/config/__init__.py:272
#: src/rougail/config/__init__.py:273
msgid "This value is only used if the version is not set in the structural file"
msgstr ""
#: src/rougail/config/__init__.py:280
#: src/rougail/config/__init__.py:281
msgid "File with functions"
msgstr ""
#: src/rougail/config/__init__.py:281
#: src/rougail/config/__init__.py:282
msgid "This file contains filters and additional Jinja2 functions usable in structure files"
msgstr ""
#: src/rougail/config/__init__.py:293
#: src/rougail/config/__init__.py:294
msgid "All modes level available"
msgstr ""
#: src/rougail/config/__init__.py:305
#: src/rougail/config/__init__.py:306
msgid "Default mode for a family"
msgstr ""
#: src/rougail/config/__init__.py:311
#: src/rougail/config/__init__.py:312
msgid "the first one defined in \"modes_level\""
msgstr ""
#: src/rougail/config/__init__.py:317 src/rougail/config/__init__.py:344
#: src/rougail/config/__init__.py:318 src/rougail/config/__init__.py:345
msgid "when no mode is defined in \"modes_level\""
msgstr ""
#: src/rougail/config/__init__.py:324 src/rougail/config/__init__.py:351
#: src/rougail/config/__init__.py:325 src/rougail/config/__init__.py:352
msgid "this mode must be available in \"modes_level\""
msgstr ""
#: src/rougail/config/__init__.py:328
#: src/rougail/config/__init__.py:329
msgid "Default mode for a variable"
msgstr ""
#: src/rougail/config/__init__.py:338
#: src/rougail/config/__init__.py:339
msgid "if the variable \"modes_level\" is defined, the default value is the second available element, otherwise, the first"
msgstr ""
#: src/rougail/config/__init__.py:355
#: src/rougail/config/__init__.py:356
msgid "Option name for the base option"
msgstr ""
#: src/rougail/config/__init__.py:360
#: src/rougail/config/__init__.py:361
msgid "In cache file, do not importation of Tiramisu and other dependencies"
msgstr ""
#: src/rougail/config/__init__.py:365
#: src/rougail/config/__init__.py:366
msgid "Store Tiramisu cache filename"
msgstr ""
#: src/rougail/config/__init__.py:366
#: src/rougail/config/__init__.py:367
msgid ""
"This file contains the Tiramisu instructions used internally to load the variables.\n"
"\n"
"This file can be used for debugging"
msgstr ""
#: src/rougail/config/__init__.py:376
#: src/rougail/config/__init__.py:377
msgid "Name of internal functions that we can use as a function"
msgstr ""
#: src/rougail/config/__init__.py:382
#: src/rougail/config/__init__.py:383
msgid "Name of extra annotators"
msgstr ""
#: src/rougail/config/__init__.py:388
#: src/rougail/config/__init__.py:389
msgid "Suffix add to generated options name"
msgstr ""
#: src/rougail/config/__init__.py:394
#: src/rougail/config/__init__.py:395
msgid "Every variables in calculation are optionals"
msgstr ""
#: src/rougail/config/__init__.py:398
#: src/rougail/config/__init__.py:399
msgid "Loads redefine variables even if there don't already exists"
msgstr ""
#: src/rougail/config/__init__.py:402
#: src/rougail/config/__init__.py:403
msgid "The secret manager"
msgstr ""
#: src/rougail/config/__init__.py:405
#: src/rougail/config/__init__.py:406
msgid "The secret pattern to constructing the name of the item searched for in the secret manager"
msgstr ""
#: src/rougail/config/__init__.py:406
#: src/rougail/config/__init__.py:407
msgid "The pattern is in Jinja2 format"
msgstr ""
#: src/rougail/config/__init__.py:415
#: src/rougail/config/__init__.py:416
msgid "structural"
msgstr ""
#: src/rougail/config/__init__.py:416
#: src/rougail/config/__init__.py:417
msgid "user datas"
msgstr ""
#: src/rougail/config/__init__.py:417
#: src/rougail/config/__init__.py:418
msgid "output"
msgstr ""
#: src/rougail/config/__init__.py:438
#: src/rougail/config/__init__.py:439
msgid "Select for {0}"
msgstr ""
#: src/rougail/config/__init__.py:500
msgid "Override default parameters for option type"
#: src/rougail/config/__init__.py:477
msgid "outputs {0} did not allow user data"
msgstr ""
#: src/rougail/config/__init__.py:503
msgid "Override default parameters for option type"
msgstr ""
#: src/rougail/config/__init__.py:506
msgid "Default parameters for option type"
msgstr ""

View file

@ -530,7 +530,6 @@ default_params:
for choice in choices:
rougail_process += f" - {choice}\n"
rougail_options += rougail_process
print(rougail_options)
return processes, processes_empty, rougail_options