fix: update doc

This commit is contained in:
egarette@silique.fr 2025-12-29 12:21:13 +01:00
parent f4ba2b1ac4
commit 0dacebbd8c
6 changed files with 26 additions and 27 deletions

View file

@ -6,16 +6,16 @@ include_toc: true
## Définir des données utilisateur interactivement dans la console
> **🛈 Informations**
> [!NOTE]
>
> L'utilisateur va entrer les valeurs des variables dans une interface en ligne de commande. Ces variables vont être affichées les unes après les autres, permettant à l'utilisateur de changer ou ajouter des valeurs.\
> **Chemin** : questionary\
> *`désactivé`*\
> **Désactivé** : si questionary n'est pas mis dans "[Sélection pour données utilisateur](#step.user_data)"
| Variable | Description | Valeur par défaut | Type |
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------|---------------------|---------------------------------------------------------------------------------------------------|
| **<a id="questionary.mandatory" name="questionary.mandatory">questionary.mandatory</a>**<br/>**Ligne de commande** : <br/>&nbsp;-qm, --questionary.mandatory<br/>&nbsp;-nqm, --questionary.no-mandatory<br/>**Variable d'environnement** : ROUGAILCLI_QUESTIONARY.MANDATORY | Demander des valeurs uniquement pour des variables obligatoires sans valeur. | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` |
| **<a id="questionary.show_secrets" name="questionary.show_secrets">questionary.show_secrets</a>**<br/>**Ligne de commande** : <br/>&nbsp;-qs, --questionary.show_secrets<br/>&nbsp;-nqs, --questionary.no-show_secrets<br/>**Variable d'environnement** : ROUGAILCLI_QUESTIONARY.SHOW_SECRETS | Afficher les secrets plutôt que de les obscurcir. | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` |
| Variable | Description | Valeur par défaut | Type |
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------|---------------------|---------------------------------------------------------------------------------------------------|
| **<a id="questionary.mandatory" name="questionary.mandatory">questionary.mandatory</a>**<br/>**Ligne de commande** : <br/>&nbsp;-qm, --questionary.mandatory<br/>&nbsp;-nqm, --questionary.no-mandatory<br/>**Variable d'environnement** : QUESTIONARY.MANDATORY | Demander des valeurs uniquement pour des variables obligatoires sans valeur. | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` |
| **<a id="questionary.show_secrets" name="questionary.show_secrets">questionary.show_secrets</a>**<br/>**Ligne de commande** : <br/>&nbsp;-qs, --questionary.show_secrets<br/>&nbsp;-nqs, --questionary.no-show_secrets<br/>**Variable d'environnement** : QUESTIONARY.SHOW_SECRETS | Afficher les secrets plutôt que de les obscurcir. | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` |

View file

@ -6,16 +6,16 @@ include_toc: true
## Define user data interactively in the console
> **🛈 Informations**
> [!NOTE]
>
> The user will enter variable values in a command-line interface. The variables will be displayed one after another, allowing the user to change or add values.\
> **Path**: questionary\
> *`disabled`*\
> **Disabled**: if questionary is not set in "[Select for user datas](#step.user_data)"
| Variable | Description | Default value | Type |
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------|-----------------|-------------------------------------------------------------------------------------------------|
| **<a id="questionary.mandatory" name="questionary.mandatory">questionary.mandatory</a>**<br/>**Command line**: <br/>&nbsp;-qm, --questionary.mandatory<br/>&nbsp;-nqm, --questionary.no-mandatory<br/>**Environment variable**: ROUGAILCLI_QUESTIONARY.MANDATORY | Ask values only for mandatories variables without any value. | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` |
| **<a id="questionary.show_secrets" name="questionary.show_secrets">questionary.show_secrets</a>**<br/>**Command line**: <br/>&nbsp;-qs, --questionary.show_secrets<br/>&nbsp;-nqs, --questionary.no-show_secrets<br/>**Environment variable**: ROUGAILCLI_QUESTIONARY.SHOW_SECRETS | Show secrets instead of obscuring them. | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` |
| Variable | Description | Default value | Type |
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------|-----------------|-------------------------------------------------------------------------------------------------|
| **<a id="questionary.mandatory" name="questionary.mandatory">questionary.mandatory</a>**<br/>**Command line**: <br/>&nbsp;-qm, --questionary.mandatory<br/>&nbsp;-nqm, --questionary.no-mandatory<br/>**Environment variable**: QUESTIONARY.MANDATORY | Ask values only for mandatories variables without any value. | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` |
| **<a id="questionary.show_secrets" name="questionary.show_secrets">questionary.show_secrets</a>**<br/>**Command line**: <br/>&nbsp;-qs, --questionary.show_secrets<br/>&nbsp;-nqs, --questionary.no-show_secrets<br/>**Environment variable**: QUESTIONARY.SHOW_SECRETS | Show secrets instead of obscuring them. | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` |

View file

@ -5,8 +5,8 @@
msgid ""
msgstr ""
"Project-Id-Version: \n"
"POT-Creation-Date: 2025-12-02 13:40+0100\n"
"PO-Revision-Date: 2025-12-02 13:43+0100\n"
"POT-Creation-Date: 2025-12-29 12:20+0100\n"
"PO-Revision-Date: 2025-12-29 12:20+0100\n"
"Last-Translator: \n"
"Language-Team: \n"
"Language: fr\n"
@ -30,16 +30,16 @@ msgstr ""
"ligne de commande. Ces variables vont être affichées les unes après les "
"autres, permettant à l'utilisateur de changer ou ajouter des valeurs."
#: src/rougail/user_data_questionary/config.py:39
#: src/rougail/user_data_questionary/config.py:38
msgid "if questionary is not set in \"step.user_data\""
msgstr "si questionary n'est pas mis dans \"step.user_data\""
#: src/rougail/user_data_questionary/config.py:42
#: src/rougail/user_data_questionary/config.py:41
msgid "Ask values only for mandatories variables without any value"
msgstr ""
"Demander des valeurs uniquement pour des variables obligatoires sans valeur"
#: src/rougail/user_data_questionary/config.py:47
#: src/rougail/user_data_questionary/config.py:46
msgid "Show secrets instead of obscuring them"
msgstr "Afficher les secrets plutôt que de les obscurcir"
@ -47,11 +47,11 @@ msgstr "Afficher les secrets plutôt que de les obscurcir"
msgid "questionary is not set in step.user_data"
msgstr "questionary n'est pas mis dans step.user_data"
#: src/rougail/user_data_questionary/data.py:229
#: src/rougail/user_data_questionary/data.py:224
msgid "Not a valid {0}"
msgstr "N'est pas un valide {0}"
#: src/rougail/user_data_questionary/data.py:250
#: src/rougail/user_data_questionary/data.py:245
msgid "Value must not be empty"
msgstr "La valeur ne doit pas être vide"

View file

@ -5,7 +5,7 @@
msgid ""
msgstr ""
"Project-Id-Version: PACKAGE VERSION\n"
"POT-Creation-Date: 2025-12-02 13:43+0100\n"
"POT-Creation-Date: 2025-12-29 12:20+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"
@ -23,15 +23,15 @@ msgstr ""
msgid "The user will enter variable values in a command-line interface. The variables will be displayed one after another, allowing the user to change or add values."
msgstr ""
#: src/rougail/user_data_questionary/config.py:39
#: src/rougail/user_data_questionary/config.py:38
msgid "if questionary is not set in \"step.user_data\""
msgstr ""
#: src/rougail/user_data_questionary/config.py:42
#: src/rougail/user_data_questionary/config.py:41
msgid "Ask values only for mandatories variables without any value"
msgstr ""
#: src/rougail/user_data_questionary/config.py:47
#: src/rougail/user_data_questionary/config.py:46
msgid "Show secrets instead of obscuring them"
msgstr ""
@ -39,11 +39,11 @@ msgstr ""
msgid "questionary is not set in step.user_data"
msgstr ""
#: src/rougail/user_data_questionary/data.py:229
#: src/rougail/user_data_questionary/data.py:224
msgid "Not a valid {0}"
msgstr ""
#: src/rougail/user_data_questionary/data.py:250
#: src/rougail/user_data_questionary/data.py:245
msgid "Value must not be empty"
msgstr ""

View file

@ -32,10 +32,9 @@ questionary:
description: {_("Define user data interactively in the console")}
help: {_("The user will enter variable values in a command-line interface. The variables will be displayed one after another, allowing the user to change or add values.")}
disabled:
jinja: |
{{% if step.user_data is not propertyerror and 'questionary' not in step.user_data %}}
disabled
{{% endif %}}
jinja: >-
{{{{ step.user_data is not propertyerror or 'questionary' not in step.user_data }}}}
return_type: boolean
description: {_('if questionary is not set in "step.user_data"')}
mandatory: