stove/rougail-output-doc
2
0
Fork 0
Code Issues 1 Pull requests Projects Releases Packages Wiki Activity
rougail-output-doc/README.md

240 lines
86 KiB
Markdown
Raw Normal View History

feat: personalise column number
2025-11-29 22:21:06 +01:00
---
gitea: none
include_toc: true
---
# Two columns
## Générer la documentation
> **🛈 Informations**
>
> **<a id="doc" name="doc">doc</a>**\
> `basic` *`désactivé`*\
> **Désactivé** : lorsque "[Générer la documentation](#doc)" n'est pas spécifié dans "[Sélection pour sortie](#step.output)"
| Variable | Description |
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **<a id="doc.title_level" name="doc.title_level">doc.title_level</a>**<br/>[`integer`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire`<br/>**Ligne de commande** : -dt, --doc.title_level<br/>**Variable d'environnement** : ROUGAILCLI_DOC.TITLE_LEVEL | Niveau de titre de départ.<br/>**Défaut** : 1 |
| **<a id="doc.contents" name="doc.contents">doc.contents</a>**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` `standard` `obligatoire` `unique`<br/>**Ligne de commande** : -dc, --doc.contents<br/>**Variable d'environnement** : ROUGAILCLI_DOC.CONTENTS | Contenu générer.<br/>**Choix** : <br/>•&nbsp;variables **← (défaut)**<br/>•&nbsp;example<br/>•&nbsp;changelog |
| **<a id="doc.previous_json_file" name="doc.previous_json_file">doc.previous_json_file</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` *`désactivé`*<br/>**Ligne de commande** : -dp, --doc.previous_json_file<br/>**Variable d'environnement** : ROUGAILCLI_DOC.PREVIOUS_JSON_FILE | Précédent fichier de description au format JSON.<br/>**Désactivé** : changelog n'est pas sélectionné dans "[Contenu générer](#doc.contents)" |
| **<a id="doc.without_family" name="doc.without_family">doc.without_family</a>**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` *`désactivé`*<br/>**Ligne de commande** : <br/>•&nbsp;-df, --doc.without_family<br/>•&nbsp;-ndf, --doc.no-without_family<br/>**Variable d'environnement** : ROUGAILCLI_DOC.WITHOUT_FAMILY | Ne pas ajouter les familles dans la documentation.<br/>**Défaut** : false<br/>**Désactivé** : if "[Générer le document au format](#doc.output_format)" is json or "[Contenu générer](#doc.contents)" hasn't variable or changelog |
| **<a id="doc.root" name="doc.root">doc.root</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard`<br/>**Ligne de commande** : -dr, --doc.root<br/>**Variable d'environnement** : ROUGAILCLI_DOC.ROOT | Documente les variables depuis cette famille. |
| **<a id="doc.with_commandline" name="doc.with_commandline">doc.with_commandline</a>**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` *`désactivé`*<br/>**Ligne de commande** : <br/>•&nbsp;-dw, --doc.with_commandline<br/>•&nbsp;-ndw, --doc.no-with_commandline<br/>**Variable d'environnement** : ROUGAILCLI_DOC.WITH_COMMANDLINE | Ajoute les informations de la ligne de commande dans la documentation.<br/>**Défaut** : false<br/>**Désactivé** : if "[Générer le document au format](#doc.output_format)" is json or "[Contenu générer](#doc.contents)" hasn't variable or changelog |
| **<a id="doc.with_environment" name="doc.with_environment">doc.with_environment</a>**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` *`désactivé`*<br/>**Ligne de commande** : <br/>•&nbsp;-de, --doc.with_environment<br/>•&nbsp;-nde, --doc.no-with_environment<br/>**Variable d'environnement** : ROUGAILCLI_DOC.WITH_ENVIRONMENT | Ajoute les informations de variable d&#x27;environnement dans la documentation.<br/>**Défaut** : false<br/>**Désactivé** : if "[Générer le document au format](#doc.output_format)" is json or "[Contenu générer](#doc.contents)" hasn't variable or changelog |
| **<a id="doc.environment_prefix" name="doc.environment_prefix">doc.environment_prefix</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` *`désactivé`*<br/>**Ligne de commande** : -dd, --doc.environment_prefix<br/>**Variable d'environnement** : ROUGAILCLI_DOC.ENVIRONMENT_PREFIX | Nom du préfixe d&#x27;environnement par défaut.<br/>**Validateur** : doit seulement utilise des caractères en majuscule<br/>**Défaut** : ROUGAIL<br/>**Désactivé** : si "__.main_namespace" n'est pas défini ou "[Ajoute les informations de variable d&#x27;environnement dans la documentation](#doc.with_environment)" est false |
## Les familles ou variables pour cette famille sont dans un autre fichier
> **🛈 Informations**
>
> **<a id="doc.other_root_filenames" name="doc.other_root_filenames">doc.other_root_filenames</a>**\
> Cette famille contient des listes de bloc de variable.\
> `basic` *`désactivé`*\
> **Désactivé** : documentation doit être séparée
| Variable | Description |
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------|
| **<a id="doc.other_root_filenames.root_path" name="doc.other_root_filenames.root_path">doc.other_root_filenames.root_path</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` `standard` `unique`<br/>**Ligne de commande** : --doc.other_root_filenames.root_path<br/>**Variable d'environnement** : ROUGAILCLI_DOC.OTHER_ROOT_FILENAMES.ROOT_PATH | Nom de la famille racine. |
| **<a id="doc.other_root_filenames.filename" name="doc.other_root_filenames.filename">doc.other_root_filenames.filename</a>**<br/>[`UNIX filename`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire`<br/>**Ligne de commande** : --doc.other_root_filenames.filename<br/>**Variable d'environnement** : ROUGAILCLI_DOC.OTHER_ROOT_FILENAMES.FILENAME | Nom du fichier.<br/>**Validateurs** : <br/>•&nbsp;this filename could be a relative path<br/>•&nbsp;file type allowed: "fichier" et "répertoire" |
| Variable | Description |
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **<a id="doc.disabled_modes" name="doc.disabled_modes">doc.disabled_modes</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` `standard` *`désactivé`* `unique`<br/>**Ligne de commande** : --doc.disabled_modes<br/>**Variable d'environnement** : ROUGAILCLI_DOC.DISABLED_MODES | Désactiver la documentation des variables avec ces modes.<br/>**Validateur** : vérifier si le mode existe déjà<br/>**Désactivé** : désactiver lorsqu'il n'y a pas de mode valable |
| **<a id="doc.change_default_value" name="doc.change_default_value">doc.change_default_value</a>**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire`<br/>**Ligne de commande** : <br/>•&nbsp;--doc.change_default_value<br/>•&nbsp;--doc.no-change_default_value<br/>**Variable d'environnement** : ROUGAILCLI_DOC.CHANGE_DEFAULT_VALUE | Valeurs modifiées pour documenter les familles leader ou dynamique.<br/>**Défaut** : true |
| **<a id="doc.comment_examples" name="doc.comment_examples">doc.comment_examples</a>**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` *`désactivé`*<br/>**Ligne de commande** : <br/>•&nbsp;-dx, --doc.comment_examples<br/>•&nbsp;-ndx, --doc.no-comment_examples<br/>**Variable d'environnement** : ROUGAILCLI_DOC.COMMENT_EXAMPLES | Ajouter la description des variables et des familles lorsqu&#x27;on génère des exemples.<br/>**Défaut** : false<br/>**Désactivé** : désactiver lorsqu'il example n'est pas dans contents |
| **<a id="doc.comment_examples_column" name="doc.comment_examples_column">doc.comment_examples_column</a>**<br/>[`integer`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` *`désactivé`*<br/>**Ligne de commande** : --doc.comment_examples_column<br/>**Variable d'environnement** : ROUGAILCLI_DOC.COMMENT_EXAMPLES_COLUMN | Commentaire dans les exemples commence à la colonne.<br/>**Défaut** : 30<br/>**Désactivé** : lorsque la variable "[Ajouter la description des variables et des familles lorsqu&#x27;on génère des exemples](#doc.comment_examples)" est accessible et a la valeur "false" |
| **<a id="doc.output_format" name="doc.output_format">doc.output_format</a>**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire`<br/>**Ligne de commande** : -do, --doc.output_format<br/>**Variable d'environnement** : ROUGAILCLI_DOC.OUTPUT_FORMAT | Générer le document au format.<br/>**Validateur** : le format de sortie json n'est pas compatible avec "changelog" et example" de la variable contents<br/>**Choix** : <br/>•&nbsp;console **← (défaut)**<br/>•&nbsp;asciidoc<br/>•&nbsp;html<br/>•&nbsp;github<br/>•&nbsp;gitlab<br/>•&nbsp;json |
| **<a id="doc.table_model" name="doc.table_model">doc.table_model</a>**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire`<br/>**Ligne de commande** : -dm, --doc.table_model<br/>**Variable d'environnement** : ROUGAILCLI_DOC.TABLE_MODEL | Generate document inside table model.<br/>**Validateur** : le format de sortie json n'est pas compatible avec "changelog" et example" de la variable contents<br/>**Choix** : <br/>•&nbsp;two_columns **← (défaut)**<br/>•&nbsp;three_columns<br/>•&nbsp;four_columns<br/>•&nbsp;five_columns<br/>•&nbsp;six_columns |
| **<a id="doc.force_true_color_terminal" name="doc.force_true_color_terminal">doc.force_true_color_terminal</a>**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire`<br/>**Ligne de commande** : <br/>•&nbsp;--doc.force_true_color_terminal<br/>•&nbsp;--doc.no-force_true_color_terminal<br/>**Variable d'environnement** : ROUGAILCLI_DOC.FORCE_TRUE_COLOR_TERMINAL | Force les vrais couleurs dans le terminal.<br/>**Défaut** : false |
# Three columns
## Générer la documentation
> **🛈 Informations**
>
> **<a id="doc" name="doc">doc</a>**\
> `basic` *`désactivé`*\
> **Désactivé** : lorsque "[Générer la documentation](#doc)" n'est pas spécifié dans "[Sélection pour sortie](#step.output)"
| Variable | Description | Default value |
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------|
| **<a id="doc.title_level" name="doc.title_level">doc.title_level</a>**<br/>[`integer`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire`<br/>**Ligne de commande** : -dt, --doc.title_level<br/>**Variable d'environnement** : ROUGAILCLI_DOC.TITLE_LEVEL | Niveau de titre de départ. | 1 |
| **<a id="doc.contents" name="doc.contents">doc.contents</a>**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` `standard` `obligatoire` `unique`<br/>**Ligne de commande** : -dc, --doc.contents<br/>**Variable d'environnement** : ROUGAILCLI_DOC.CONTENTS | Contenu générer.<br/>**Choix** : <br/>•&nbsp;variables<br/>•&nbsp;example<br/>•&nbsp;changelog | •&nbsp;variables |
| **<a id="doc.previous_json_file" name="doc.previous_json_file">doc.previous_json_file</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` *`désactivé`*<br/>**Ligne de commande** : -dp, --doc.previous_json_file<br/>**Variable d'environnement** : ROUGAILCLI_DOC.PREVIOUS_JSON_FILE | Précédent fichier de description au format JSON.<br/>**Désactivé** : changelog n'est pas sélectionné dans "[Contenu générer](#doc.contents)" | |
| **<a id="doc.without_family" name="doc.without_family">doc.without_family</a>**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` *`désactivé`*<br/>**Ligne de commande** : <br/>•&nbsp;-df, --doc.without_family<br/>•&nbsp;-ndf, --doc.no-without_family<br/>**Variable d'environnement** : ROUGAILCLI_DOC.WITHOUT_FAMILY | Ne pas ajouter les familles dans la documentation.<br/>**Désactivé** : if "[Générer le document au format](#doc.output_format)" is json or "[Contenu générer](#doc.contents)" hasn't variable or changelog | false |
| **<a id="doc.root" name="doc.root">doc.root</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard`<br/>**Ligne de commande** : -dr, --doc.root<br/>**Variable d'environnement** : ROUGAILCLI_DOC.ROOT | Documente les variables depuis cette famille. | |
| **<a id="doc.with_commandline" name="doc.with_commandline">doc.with_commandline</a>**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` *`désactivé`*<br/>**Ligne de commande** : <br/>•&nbsp;-dw, --doc.with_commandline<br/>•&nbsp;-ndw, --doc.no-with_commandline<br/>**Variable d'environnement** : ROUGAILCLI_DOC.WITH_COMMANDLINE | Ajoute les informations de la ligne de commande dans la documentation.<br/>**Désactivé** : if "[Générer le document au format](#doc.output_format)" is json or "[Contenu générer](#doc.contents)" hasn't variable or changelog | false |
| **<a id="doc.with_environment" name="doc.with_environment">doc.with_environment</a>**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` *`désactivé`*<br/>**Ligne de commande** : <br/>•&nbsp;-de, --doc.with_environment<br/>•&nbsp;-nde, --doc.no-with_environment<br/>**Variable d'environnement** : ROUGAILCLI_DOC.WITH_ENVIRONMENT | Ajoute les informations de variable d&#x27;environnement dans la documentation.<br/>**Désactivé** : if "[Générer le document au format](#doc.output_format)" is json or "[Contenu générer](#doc.contents)" hasn't variable or changelog | false |
| **<a id="doc.environment_prefix" name="doc.environment_prefix">doc.environment_prefix</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` *`désactivé`*<br/>**Ligne de commande** : -dd, --doc.environment_prefix<br/>**Variable d'environnement** : ROUGAILCLI_DOC.ENVIRONMENT_PREFIX | Nom du préfixe d&#x27;environnement par défaut.<br/>**Validateur** : doit seulement utilise des caractères en majuscule<br/>**Désactivé** : si "__.main_namespace" n'est pas défini ou "[Ajoute les informations de variable d&#x27;environnement dans la documentation](#doc.with_environment)" est false | ROUGAIL |
## Les familles ou variables pour cette famille sont dans un autre fichier
> **🛈 Informations**
>
> **<a id="doc.other_root_filenames" name="doc.other_root_filenames">doc.other_root_filenames</a>**\
> Cette famille contient des listes de bloc de variable.\
> `basic` *`désactivé`*\
> **Désactivé** : documentation doit être séparée
| Variable | Description |
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------|
| **<a id="doc.other_root_filenames.root_path" name="doc.other_root_filenames.root_path">doc.other_root_filenames.root_path</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` `standard` `unique`<br/>**Ligne de commande** : --doc.other_root_filenames.root_path<br/>**Variable d'environnement** : ROUGAILCLI_DOC.OTHER_ROOT_FILENAMES.ROOT_PATH | Nom de la famille racine. |
| **<a id="doc.other_root_filenames.filename" name="doc.other_root_filenames.filename">doc.other_root_filenames.filename</a>**<br/>[`UNIX filename`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire`<br/>**Ligne de commande** : --doc.other_root_filenames.filename<br/>**Variable d'environnement** : ROUGAILCLI_DOC.OTHER_ROOT_FILENAMES.FILENAME | Nom du fichier.<br/>**Validateurs** : <br/>•&nbsp;this filename could be a relative path<br/>•&nbsp;file type allowed: "fichier" et "répertoire" |
| Variable | Description | Default value |
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------|
| **<a id="doc.disabled_modes" name="doc.disabled_modes">doc.disabled_modes</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` `standard` *`désactivé`* `unique`<br/>**Ligne de commande** : --doc.disabled_modes<br/>**Variable d'environnement** : ROUGAILCLI_DOC.DISABLED_MODES | Désactiver la documentation des variables avec ces modes.<br/>**Validateur** : vérifier si le mode existe déjà<br/>**Désactivé** : désactiver lorsqu'il n'y a pas de mode valable | |
| **<a id="doc.change_default_value" name="doc.change_default_value">doc.change_default_value</a>**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire`<br/>**Ligne de commande** : <br/>•&nbsp;--doc.change_default_value<br/>•&nbsp;--doc.no-change_default_value<br/>**Variable d'environnement** : ROUGAILCLI_DOC.CHANGE_DEFAULT_VALUE | Valeurs modifiées pour documenter les familles leader ou dynamique. | true |
| **<a id="doc.comment_examples" name="doc.comment_examples">doc.comment_examples</a>**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` *`désactivé`*<br/>**Ligne de commande** : <br/>•&nbsp;-dx, --doc.comment_examples<br/>•&nbsp;-ndx, --doc.no-comment_examples<br/>**Variable d'environnement** : ROUGAILCLI_DOC.COMMENT_EXAMPLES | Ajouter la description des variables et des familles lorsqu&#x27;on génère des exemples.<br/>**Désactivé** : désactiver lorsqu'il example n'est pas dans contents | false |
| **<a id="doc.comment_examples_column" name="doc.comment_examples_column">doc.comment_examples_column</a>**<br/>[`integer`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` *`désactivé`*<br/>**Ligne de commande** : --doc.comment_examples_column<br/>**Variable d'environnement** : ROUGAILCLI_DOC.COMMENT_EXAMPLES_COLUMN | Commentaire dans les exemples commence à la colonne.<br/>**Désactivé** : lorsque la variable "[Ajouter la description des variables et des familles lorsqu&#x27;on génère des exemples](#doc.comment_examples)" est accessible et a la valeur "false" | 30 |
| **<a id="doc.output_format" name="doc.output_format">doc.output_format</a>**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire`<br/>**Ligne de commande** : -do, --doc.output_format<br/>**Variable d'environnement** : ROUGAILCLI_DOC.OUTPUT_FORMAT | Générer le document au format.<br/>**Validateur** : le format de sortie json n'est pas compatible avec "changelog" et example" de la variable contents<br/>**Choix** : <br/>•&nbsp;console<br/>•&nbsp;asciidoc<br/>•&nbsp;html<br/>•&nbsp;github<br/>•&nbsp;gitlab<br/>•&nbsp;json | console |
| **<a id="doc.table_model" name="doc.table_model">doc.table_model</a>**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire`<br/>**Ligne de commande** : -dm, --doc.table_model<br/>**Variable d'environnement** : ROUGAILCLI_DOC.TABLE_MODEL | Generate document inside table model.<br/>**Validateur** : le format de sortie json n'est pas compatible avec "changelog" et example" de la variable contents<br/>**Choix** : <br/>•&nbsp;two_columns<br/>•&nbsp;three_columns<br/>•&nbsp;four_columns<br/>•&nbsp;five_columns<br/>•&nbsp;six_columns | two_columns |
| **<a id="doc.force_true_color_terminal" name="doc.force_true_color_terminal">doc.force_true_color_terminal</a>**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire`<br/>**Ligne de commande** : <br/>•&nbsp;--doc.force_true_color_terminal<br/>•&nbsp;--doc.no-force_true_color_terminal<br/>**Variable d'environnement** : ROUGAILCLI_DOC.FORCE_TRUE_COLOR_TERMINAL | Force les vrais couleurs dans le terminal. | false |
# Four columns
## Générer la documentation
feat: document commandline and environment variable
2025-11-27 22:17:17 +01:00
> **🛈 Informations**
>
> **<a id="doc" name="doc">doc</a>**\
feat: personalise column number
2025-11-29 22:21:06 +01:00
> `basic` *`désactivé`*\
> **Désactivé** : lorsque "[Générer la documentation](#doc)" n'est pas spécifié dans "[Sélection pour sortie](#step.output)"
feat: document commandline and environment variable
2025-11-27 22:17:17 +01:00
feat: personalise column number
2025-11-29 22:21:06 +01:00
| Variable | Description | Default value | Type |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------|-------------------------------------------------------------------------------------------------------------|
| **<a id="doc.title_level" name="doc.title_level">doc.title_level</a>**<br/>`standard`<br/>**Ligne de commande** : -dt, --doc.title_level<br/>**Variable d'environnement** : ROUGAILCLI_DOC.TITLE_LEVEL | Niveau de titre de départ. | 1 | [`integer`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` |
| **<a id="doc.contents" name="doc.contents">doc.contents</a>**<br/>`standard` `unique`<br/>**Ligne de commande** : -dc, --doc.contents<br/>**Variable d'environnement** : ROUGAILCLI_DOC.CONTENTS | Contenu générer.<br/>**Choix** : <br/>•&nbsp;variables<br/>•&nbsp;example<br/>•&nbsp;changelog | •&nbsp;variables | [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` `obligatoire` |
| **<a id="doc.previous_json_file" name="doc.previous_json_file">doc.previous_json_file</a>**<br/>`basic` *`désactivé`*<br/>**Ligne de commande** : -dp, --doc.previous_json_file<br/>**Variable d'environnement** : ROUGAILCLI_DOC.PREVIOUS_JSON_FILE | Précédent fichier de description au format JSON.<br/>**Désactivé** : changelog n'est pas sélectionné dans "[Contenu générer](#doc.contents)" | | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` |
| **<a id="doc.without_family" name="doc.without_family">doc.without_family</a>**<br/>`standard` *`désactivé`*<br/>**Ligne de commande** : <br/>•&nbsp;-df, --doc.without_family<br/>•&nbsp;-ndf, --doc.no-without_family<br/>**Variable d'environnement** : ROUGAILCLI_DOC.WITHOUT_FAMILY | Ne pas ajouter les familles dans la documentation.<br/>**Désactivé** : if "[Générer le document au format](#doc.output_format)" is json or "[Contenu générer](#doc.contents)" hasn't variable or changelog | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` |
| **<a id="doc.root" name="doc.root">doc.root</a>**<br/>`standard`<br/>**Ligne de commande** : -dr, --doc.root<br/>**Variable d'environnement** : ROUGAILCLI_DOC.ROOT | Documente les variables depuis cette famille. | | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) |
| **<a id="doc.with_commandline" name="doc.with_commandline">doc.with_commandline</a>**<br/>`standard` *`désactivé`*<br/>**Ligne de commande** : <br/>•&nbsp;-dw, --doc.with_commandline<br/>•&nbsp;-ndw, --doc.no-with_commandline<br/>**Variable d'environnement** : ROUGAILCLI_DOC.WITH_COMMANDLINE | Ajoute les informations de la ligne de commande dans la documentation.<br/>**Désactivé** : if "[Générer le document au format](#doc.output_format)" is json or "[Contenu générer](#doc.contents)" hasn't variable or changelog | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` |
| **<a id="doc.with_environment" name="doc.with_environment">doc.with_environment</a>**<br/>`standard` *`désactivé`*<br/>**Ligne de commande** : <br/>•&nbsp;-de, --doc.with_environment<br/>•&nbsp;-nde, --doc.no-with_environment<br/>**Variable d'environnement** : ROUGAILCLI_DOC.WITH_ENVIRONMENT | Ajoute les informations de variable d&#x27;environnement dans la documentation.<br/>**Désactivé** : if "[Générer le document au format](#doc.output_format)" is json or "[Contenu générer](#doc.contents)" hasn't variable or changelog | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` |
| **<a id="doc.environment_prefix" name="doc.environment_prefix">doc.environment_prefix</a>**<br/>`standard` *`désactivé`*<br/>**Ligne de commande** : -dd, --doc.environment_prefix<br/>**Variable d'environnement** : ROUGAILCLI_DOC.ENVIRONMENT_PREFIX | Nom du préfixe d&#x27;environnement par défaut.<br/>**Validateur** : doit seulement utilise des caractères en majuscule<br/>**Désactivé** : si "__.main_namespace" n'est pas défini ou "[Ajoute les informations de variable d&#x27;environnement dans la documentation](#doc.with_environment)" est false | ROUGAIL | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` |
feat: document commandline and environment variable
2025-11-27 22:17:17 +01:00
feat: personalise column number
2025-11-29 22:21:06 +01:00
## Les familles ou variables pour cette famille sont dans un autre fichier
feat: document commandline and environment variable
2025-11-27 22:17:17 +01:00
> **🛈 Informations**
>
> **<a id="doc.other_root_filenames" name="doc.other_root_filenames">doc.other_root_filenames</a>**\
feat: personalise column number
2025-11-29 22:21:06 +01:00
> Cette famille contient des listes de bloc de variable.\
> `basic` *`désactivé`*\
> **Désactivé** : documentation doit être séparée
| Variable | Description | Type |
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------|
| **<a id="doc.other_root_filenames.root_path" name="doc.other_root_filenames.root_path">doc.other_root_filenames.root_path</a>**<br/>`standard` `unique`<br/>**Ligne de commande** : --doc.other_root_filenames.root_path<br/>**Variable d'environnement** : ROUGAILCLI_DOC.OTHER_ROOT_FILENAMES.ROOT_PATH | Nom de la famille racine. | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` |
| **<a id="doc.other_root_filenames.filename" name="doc.other_root_filenames.filename">doc.other_root_filenames.filename</a>**<br/>`basic`<br/>**Ligne de commande** : --doc.other_root_filenames.filename<br/>**Variable d'environnement** : ROUGAILCLI_DOC.OTHER_ROOT_FILENAMES.FILENAME | Nom du fichier.<br/>**Validateurs** : <br/>•&nbsp;this filename could be a relative path<br/>•&nbsp;file type allowed: "fichier" et "répertoire" | [`UNIX filename`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` |
| Variable | Description | Default value | Type |
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------|---------------------------------------------------------------------------------------------------|
| **<a id="doc.disabled_modes" name="doc.disabled_modes">doc.disabled_modes</a>**<br/>`standard` *`désactivé`* `unique`<br/>**Ligne de commande** : --doc.disabled_modes<br/>**Variable d'environnement** : ROUGAILCLI_DOC.DISABLED_MODES | Désactiver la documentation des variables avec ces modes.<br/>**Validateur** : vérifier si le mode existe déjà<br/>**Désactivé** : désactiver lorsqu'il n'y a pas de mode valable | | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` |
| **<a id="doc.change_default_value" name="doc.change_default_value">doc.change_default_value</a>**<br/>`standard`<br/>**Ligne de commande** : <br/>•&nbsp;--doc.change_default_value<br/>•&nbsp;--doc.no-change_default_value<br/>**Variable d'environnement** : ROUGAILCLI_DOC.CHANGE_DEFAULT_VALUE | Valeurs modifiées pour documenter les familles leader ou dynamique. | true | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` |
| **<a id="doc.comment_examples" name="doc.comment_examples">doc.comment_examples</a>**<br/>`standard` *`désactivé`*<br/>**Ligne de commande** : <br/>•&nbsp;-dx, --doc.comment_examples<br/>•&nbsp;-ndx, --doc.no-comment_examples<br/>**Variable d'environnement** : ROUGAILCLI_DOC.COMMENT_EXAMPLES | Ajouter la description des variables et des familles lorsqu&#x27;on génère des exemples.<br/>**Désactivé** : désactiver lorsqu'il example n'est pas dans contents | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` |
| **<a id="doc.comment_examples_column" name="doc.comment_examples_column">doc.comment_examples_column</a>**<br/>`standard` *`désactivé`*<br/>**Ligne de commande** : --doc.comment_examples_column<br/>**Variable d'environnement** : ROUGAILCLI_DOC.COMMENT_EXAMPLES_COLUMN | Commentaire dans les exemples commence à la colonne.<br/>**Désactivé** : lorsque la variable "[Ajouter la description des variables et des familles lorsqu&#x27;on génère des exemples](#doc.comment_examples)" est accessible et a la valeur "false" | 30 | [`integer`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` |
| **<a id="doc.output_format" name="doc.output_format">doc.output_format</a>**<br/>`standard`<br/>**Ligne de commande** : -do, --doc.output_format<br/>**Variable d'environnement** : ROUGAILCLI_DOC.OUTPUT_FORMAT | Générer le document au format.<br/>**Validateur** : le format de sortie json n'est pas compatible avec "changelog" et example" de la variable contents<br/>**Choix** : <br/>•&nbsp;console<br/>•&nbsp;asciidoc<br/>•&nbsp;html<br/>•&nbsp;github<br/>•&nbsp;gitlab<br/>•&nbsp;json | console | [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` |
| **<a id="doc.table_model" name="doc.table_model">doc.table_model</a>**<br/>`standard`<br/>**Ligne de commande** : -dm, --doc.table_model<br/>**Variable d'environnement** : ROUGAILCLI_DOC.TABLE_MODEL | Generate document inside table model.<br/>**Validateur** : le format de sortie json n'est pas compatible avec "changelog" et example" de la variable contents<br/>**Choix** : <br/>•&nbsp;two_columns<br/>•&nbsp;three_columns<br/>•&nbsp;four_columns<br/>•&nbsp;five_columns<br/>•&nbsp;six_columns | two_columns | [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` |
| **<a id="doc.force_true_color_terminal" name="doc.force_true_color_terminal">doc.force_true_color_terminal</a>**<br/>`standard`<br/>**Ligne de commande** : <br/>•&nbsp;--doc.force_true_color_terminal<br/>•&nbsp;--doc.no-force_true_color_terminal<br/>**Variable d'environnement** : ROUGAILCLI_DOC.FORCE_TRUE_COLOR_TERMINAL | Force les vrais couleurs dans le terminal. | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` |
# Five columns
## Générer la documentation
> **🛈 Informations**
>
> **<a id="doc" name="doc">doc</a>**\
> `basic` *`désactivé`*\
> **Désactivé** : lorsque "[Générer la documentation](#doc)" n'est pas spécifié dans "[Sélection pour sortie](#step.output)"
| Variable | Description | Default value | Type | Access control |
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------|------------------|-------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **<a id="doc.title_level" name="doc.title_level">doc.title_level</a>**<br/>**Ligne de commande** : -dt, --doc.title_level<br/>**Variable d'environnement** : ROUGAILCLI_DOC.TITLE_LEVEL | Niveau de titre de départ. | 1 | [`integer`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | `standard` |
| **<a id="doc.contents" name="doc.contents">doc.contents</a>**<br/>`unique`<br/>**Ligne de commande** : -dc, --doc.contents<br/>**Variable d'environnement** : ROUGAILCLI_DOC.CONTENTS | Contenu générer.<br/>**Choix** : <br/>•&nbsp;variables<br/>•&nbsp;example<br/>•&nbsp;changelog | •&nbsp;variables | [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` `obligatoire` | `standard` |
| **<a id="doc.previous_json_file" name="doc.previous_json_file">doc.previous_json_file</a>**<br/>**Ligne de commande** : -dp, --doc.previous_json_file<br/>**Variable d'environnement** : ROUGAILCLI_DOC.PREVIOUS_JSON_FILE | Précédent fichier de description au format JSON. | | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | `basic` *`désactivé`*<br/>**Désactivé** : changelog n'est pas sélectionné dans "[Contenu générer](#doc.contents)" |
| **<a id="doc.without_family" name="doc.without_family">doc.without_family</a>**<br/>**Ligne de commande** : <br/>•&nbsp;-df, --doc.without_family<br/>•&nbsp;-ndf, --doc.no-without_family<br/>**Variable d'environnement** : ROUGAILCLI_DOC.WITHOUT_FAMILY | Ne pas ajouter les familles dans la documentation. | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | `standard` *`désactivé`*<br/>**Désactivé** : if "[Générer le document au format](#doc.output_format)" is json or "[Contenu générer](#doc.contents)" hasn't variable or changelog |
| **<a id="doc.root" name="doc.root">doc.root</a>**<br/>**Ligne de commande** : -dr, --doc.root<br/>**Variable d'environnement** : ROUGAILCLI_DOC.ROOT | Documente les variables depuis cette famille. | | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) | `standard` |
| **<a id="doc.with_commandline" name="doc.with_commandline">doc.with_commandline</a>**<br/>**Ligne de commande** : <br/>•&nbsp;-dw, --doc.with_commandline<br/>•&nbsp;-ndw, --doc.no-with_commandline<br/>**Variable d'environnement** : ROUGAILCLI_DOC.WITH_COMMANDLINE | Ajoute les informations de la ligne de commande dans la documentation. | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | `standard` *`désactivé`*<br/>**Désactivé** : if "[Générer le document au format](#doc.output_format)" is json or "[Contenu générer](#doc.contents)" hasn't variable or changelog |
| **<a id="doc.with_environment" name="doc.with_environment">doc.with_environment</a>**<br/>**Ligne de commande** : <br/>•&nbsp;-de, --doc.with_environment<br/>•&nbsp;-nde, --doc.no-with_environment<br/>**Variable d'environnement** : ROUGAILCLI_DOC.WITH_ENVIRONMENT | Ajoute les informations de variable d&#x27;environnement dans la documentation. | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | `standard` *`désactivé`*<br/>**Désactivé** : if "[Générer le document au format](#doc.output_format)" is json or "[Contenu générer](#doc.contents)" hasn't variable or changelog |
| **<a id="doc.environment_prefix" name="doc.environment_prefix">doc.environment_prefix</a>**<br/>**Ligne de commande** : -dd, --doc.environment_prefix<br/>**Variable d'environnement** : ROUGAILCLI_DOC.ENVIRONMENT_PREFIX | Nom du préfixe d&#x27;environnement par défaut.<br/>**Validateur** : doit seulement utilise des caractères en majuscule | ROUGAIL | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | `standard` *`désactivé`*<br/>**Désactivé** : si "__.main_namespace" n'est pas défini ou "[Ajoute les informations de variable d&#x27;environnement dans la documentation](#doc.with_environment)" est false |
## Les familles ou variables pour cette famille sont dans un autre fichier
> **🛈 Informations**
>
> **<a id="doc.other_root_filenames" name="doc.other_root_filenames">doc.other_root_filenames</a>**\
> Cette famille contient des listes de bloc de variable.\
> `basic` *`désactivé`*\
> **Désactivé** : documentation doit être séparée
| Variable | Description | Type | Access control |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------|------------------|
| **<a id="doc.other_root_filenames.root_path" name="doc.other_root_filenames.root_path">doc.other_root_filenames.root_path</a>**<br/>`unique`<br/>**Ligne de commande** : --doc.other_root_filenames.root_path<br/>**Variable d'environnement** : ROUGAILCLI_DOC.OTHER_ROOT_FILENAMES.ROOT_PATH | Nom de la famille racine. | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` | `standard` |
| **<a id="doc.other_root_filenames.filename" name="doc.other_root_filenames.filename">doc.other_root_filenames.filename</a>**<br/>**Ligne de commande** : --doc.other_root_filenames.filename<br/>**Variable d'environnement** : ROUGAILCLI_DOC.OTHER_ROOT_FILENAMES.FILENAME | Nom du fichier.<br/>**Validateurs** : <br/>•&nbsp;this filename could be a relative path<br/>•&nbsp;file type allowed: "fichier" et "répertoire" | [`UNIX filename`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | `basic` |
| Variable | Description | Default value | Type | Access control |
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------|---------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **<a id="doc.disabled_modes" name="doc.disabled_modes">doc.disabled_modes</a>**<br/>`unique`<br/>**Ligne de commande** : --doc.disabled_modes<br/>**Variable d'environnement** : ROUGAILCLI_DOC.DISABLED_MODES | Désactiver la documentation des variables avec ces modes.<br/>**Validateur** : vérifier si le mode existe déjà | | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` | `standard` *`désactivé`*<br/>**Désactivé** : désactiver lorsqu'il n'y a pas de mode valable |
| **<a id="doc.change_default_value" name="doc.change_default_value">doc.change_default_value</a>**<br/>**Ligne de commande** : <br/>•&nbsp;--doc.change_default_value<br/>•&nbsp;--doc.no-change_default_value<br/>**Variable d'environnement** : ROUGAILCLI_DOC.CHANGE_DEFAULT_VALUE | Valeurs modifiées pour documenter les familles leader ou dynamique. | true | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | `standard` |
| **<a id="doc.comment_examples" name="doc.comment_examples">doc.comment_examples</a>**<br/>**Ligne de commande** : <br/>•&nbsp;-dx, --doc.comment_examples<br/>•&nbsp;-ndx, --doc.no-comment_examples<br/>**Variable d'environnement** : ROUGAILCLI_DOC.COMMENT_EXAMPLES | Ajouter la description des variables et des familles lorsqu&#x27;on génère des exemples. | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | `standard` *`désactivé`*<br/>**Désactivé** : désactiver lorsqu'il example n'est pas dans contents |
| **<a id="doc.comment_examples_column" name="doc.comment_examples_column">doc.comment_examples_column</a>**<br/>**Ligne de commande** : --doc.comment_examples_column<br/>**Variable d'environnement** : ROUGAILCLI_DOC.COMMENT_EXAMPLES_COLUMN | Commentaire dans les exemples commence à la colonne. | 30 | [`integer`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | `standard` *`désactivé`*<br/>**Désactivé** : lorsque la variable "[Ajouter la description des variables et des familles lorsqu&#x27;on génère des exemples](#doc.comment_examples)" est accessible et a la valeur "false" |
| **<a id="doc.output_format" name="doc.output_format">doc.output_format</a>**<br/>**Ligne de commande** : -do, --doc.output_format<br/>**Variable d'environnement** : ROUGAILCLI_DOC.OUTPUT_FORMAT | Générer le document au format.<br/>**Validateur** : le format de sortie json n'est pas compatible avec "changelog" et example" de la variable contents<br/>**Choix** : <br/>•&nbsp;console<br/>•&nbsp;asciidoc<br/>•&nbsp;html<br/>•&nbsp;github<br/>•&nbsp;gitlab<br/>•&nbsp;json | console | [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | `standard` |
| **<a id="doc.table_model" name="doc.table_model">doc.table_model</a>**<br/>**Ligne de commande** : -dm, --doc.table_model<br/>**Variable d'environnement** : ROUGAILCLI_DOC.TABLE_MODEL | Generate document inside table model.<br/>**Validateur** : le format de sortie json n'est pas compatible avec "changelog" et example" de la variable contents<br/>**Choix** : <br/>•&nbsp;two_columns<br/>•&nbsp;three_columns<br/>•&nbsp;four_columns<br/>•&nbsp;five_columns<br/>•&nbsp;six_columns | two_columns | [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | `standard` |
| **<a id="doc.force_true_color_terminal" name="doc.force_true_color_terminal">doc.force_true_color_terminal</a>**<br/>**Ligne de commande** : <br/>•&nbsp;--doc.force_true_color_terminal<br/>•&nbsp;--doc.no-force_true_color_terminal<br/>**Variable d'environnement** : ROUGAILCLI_DOC.FORCE_TRUE_COLOR_TERMINAL | Force les vrais couleurs dans le terminal. | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | `standard` |
# Six columns
## Générer la documentation
> **🛈 Informations**
>
> **<a id="doc" name="doc">doc</a>**\
> `basic` *`désactivé`*\
> **Désactivé** : lorsque "[Générer la documentation](#doc)" n'est pas spécifié dans "[Sélection pour sortie](#step.output)"
| Variable | Description | Default value | Type | Access control | Validateur |
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------|------------------|-------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------|
| **<a id="doc.title_level" name="doc.title_level">doc.title_level</a>**<br/>**Ligne de commande** : -dt, --doc.title_level<br/>**Variable d'environnement** : ROUGAILCLI_DOC.TITLE_LEVEL | Niveau de titre de départ. | 1 | [`integer`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | `standard` | |
| **<a id="doc.contents" name="doc.contents">doc.contents</a>**<br/>**Ligne de commande** : -dc, --doc.contents<br/>**Variable d'environnement** : ROUGAILCLI_DOC.CONTENTS | Contenu générer.<br/>**Choix** : <br/>•&nbsp;variables<br/>•&nbsp;example<br/>•&nbsp;changelog | •&nbsp;variables | [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` `obligatoire` | `standard` | `unique` |
| **<a id="doc.previous_json_file" name="doc.previous_json_file">doc.previous_json_file</a>**<br/>**Ligne de commande** : -dp, --doc.previous_json_file<br/>**Variable d'environnement** : ROUGAILCLI_DOC.PREVIOUS_JSON_FILE | Précédent fichier de description au format JSON. | | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | `basic` *`désactivé`*<br/>**Désactivé** : changelog n'est pas sélectionné dans "[Contenu générer](#doc.contents)" | |
| **<a id="doc.without_family" name="doc.without_family">doc.without_family</a>**<br/>**Ligne de commande** : <br/>•&nbsp;-df, --doc.without_family<br/>•&nbsp;-ndf, --doc.no-without_family<br/>**Variable d'environnement** : ROUGAILCLI_DOC.WITHOUT_FAMILY | Ne pas ajouter les familles dans la documentation. | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | `standard` *`désactivé`*<br/>**Désactivé** : if "[Générer le document au format](#doc.output_format)" is json or "[Contenu générer](#doc.contents)" hasn't variable or changelog | |
| **<a id="doc.root" name="doc.root">doc.root</a>**<br/>**Ligne de commande** : -dr, --doc.root<br/>**Variable d'environnement** : ROUGAILCLI_DOC.ROOT | Documente les variables depuis cette famille. | | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) | `standard` | |
| **<a id="doc.with_commandline" name="doc.with_commandline">doc.with_commandline</a>**<br/>**Ligne de commande** : <br/>•&nbsp;-dw, --doc.with_commandline<br/>•&nbsp;-ndw, --doc.no-with_commandline<br/>**Variable d'environnement** : ROUGAILCLI_DOC.WITH_COMMANDLINE | Ajoute les informations de la ligne de commande dans la documentation. | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | `standard` *`désactivé`*<br/>**Désactivé** : if "[Générer le document au format](#doc.output_format)" is json or "[Contenu générer](#doc.contents)" hasn't variable or changelog | |
| **<a id="doc.with_environment" name="doc.with_environment">doc.with_environment</a>**<br/>**Ligne de commande** : <br/>•&nbsp;-de, --doc.with_environment<br/>•&nbsp;-nde, --doc.no-with_environment<br/>**Variable d'environnement** : ROUGAILCLI_DOC.WITH_ENVIRONMENT | Ajoute les informations de variable d&#x27;environnement dans la documentation. | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | `standard` *`désactivé`*<br/>**Désactivé** : if "[Générer le document au format](#doc.output_format)" is json or "[Contenu générer](#doc.contents)" hasn't variable or changelog | |
| **<a id="doc.environment_prefix" name="doc.environment_prefix">doc.environment_prefix</a>**<br/>**Ligne de commande** : -dd, --doc.environment_prefix<br/>**Variable d'environnement** : ROUGAILCLI_DOC.ENVIRONMENT_PREFIX | Nom du préfixe d&#x27;environnement par défaut. | ROUGAIL | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | `standard` *`désactivé`*<br/>**Désactivé** : si "__.main_namespace" n'est pas défini ou "[Ajoute les informations de variable d&#x27;environnement dans la documentation](#doc.with_environment)" est false | Doit seulement utilise des caractères en majuscule. |
## Les familles ou variables pour cette famille sont dans un autre fichier
> **🛈 Informations**
>
> **<a id="doc.other_root_filenames" name="doc.other_root_filenames">doc.other_root_filenames</a>**\
> Cette famille contient des listes de bloc de variable.\
> `basic` *`désactivé`*\
> **Désactivé** : documentation doit être séparée
| Variable | Description | Type | Access control | Validateur |
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------|---------------------------------------------------------------------------------------------------------|------------------|--------------------------------------------------------------------------------------------------------|
| **<a id="doc.other_root_filenames.root_path" name="doc.other_root_filenames.root_path">doc.other_root_filenames.root_path</a>**<br/>**Ligne de commande** : --doc.other_root_filenames.root_path<br/>**Variable d'environnement** : ROUGAILCLI_DOC.OTHER_ROOT_FILENAMES.ROOT_PATH | Nom de la famille racine. | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` | `standard` | `unique` |
| **<a id="doc.other_root_filenames.filename" name="doc.other_root_filenames.filename">doc.other_root_filenames.filename</a>**<br/>**Ligne de commande** : --doc.other_root_filenames.filename<br/>**Variable d'environnement** : ROUGAILCLI_DOC.OTHER_ROOT_FILENAMES.FILENAME | Nom du fichier. | [`UNIX filename`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | `basic` | •&nbsp;this filename could be a relative path<br/>•&nbsp;file type allowed: "fichier" et "répertoire". |
| Variable | Description | Default value | Type | Access control | Validateur |
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------|---------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------|
| **<a id="doc.disabled_modes" name="doc.disabled_modes">doc.disabled_modes</a>**<br/>**Ligne de commande** : --doc.disabled_modes<br/>**Variable d'environnement** : ROUGAILCLI_DOC.DISABLED_MODES | Désactiver la documentation des variables avec ces modes. | | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` | `standard` *`désactivé`*<br/>**Désactivé** : désactiver lorsqu'il n'y a pas de mode valable | `unique`<br/>Vérifier si le mode existe déjà. |
| **<a id="doc.change_default_value" name="doc.change_default_value">doc.change_default_value</a>**<br/>**Ligne de commande** : <br/>•&nbsp;--doc.change_default_value<br/>•&nbsp;--doc.no-change_default_value<br/>**Variable d'environnement** : ROUGAILCLI_DOC.CHANGE_DEFAULT_VALUE | Valeurs modifiées pour documenter les familles leader ou dynamique. | true | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | `standard` | |
| **<a id="doc.comment_examples" name="doc.comment_examples">doc.comment_examples</a>**<br/>**Ligne de commande** : <br/>•&nbsp;-dx, --doc.comment_examples<br/>•&nbsp;-ndx, --doc.no-comment_examples<br/>**Variable d'environnement** : ROUGAILCLI_DOC.COMMENT_EXAMPLES | Ajouter la description des variables et des familles lorsqu&#x27;on génère des exemples. | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | `standard` *`désactivé`*<br/>**Désactivé** : désactiver lorsqu'il example n'est pas dans contents | |
| **<a id="doc.comment_examples_column" name="doc.comment_examples_column">doc.comment_examples_column</a>**<br/>**Ligne de commande** : --doc.comment_examples_column<br/>**Variable d'environnement** : ROUGAILCLI_DOC.COMMENT_EXAMPLES_COLUMN | Commentaire dans les exemples commence à la colonne. | 30 | [`integer`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | `standard` *`désactivé`*<br/>**Désactivé** : lorsque la variable "[Ajouter la description des variables et des familles lorsqu&#x27;on génère des exemples](#doc.comment_examples)" est accessible et a la valeur "false" | |
| **<a id="doc.output_format" name="doc.output_format">doc.output_format</a>**<br/>**Ligne de commande** : -do, --doc.output_format<br/>**Variable d'environnement** : ROUGAILCLI_DOC.OUTPUT_FORMAT | Générer le document au format.<br/>**Choix** : <br/>•&nbsp;console<br/>•&nbsp;asciidoc<br/>•&nbsp;html<br/>•&nbsp;github<br/>•&nbsp;gitlab<br/>•&nbsp;json | console | [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | `standard` | Le format de sortie json n'est pas compatible avec "changelog" et example" de la variable contents. |
| **<a id="doc.table_model" name="doc.table_model">doc.table_model</a>**<br/>**Ligne de commande** : -dm, --doc.table_model<br/>**Variable d'environnement** : ROUGAILCLI_DOC.TABLE_MODEL | Generate document inside table model.<br/>**Choix** : <br/>•&nbsp;two_columns<br/>•&nbsp;three_columns<br/>•&nbsp;four_columns<br/>•&nbsp;five_columns<br/>•&nbsp;six_columns | two_columns | [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | `standard` | Le format de sortie json n'est pas compatible avec "changelog" et example" de la variable contents. |
| **<a id="doc.force_true_color_terminal" name="doc.force_true_color_terminal">doc.force_true_color_terminal</a>**<br/>**Ligne de commande** : <br/>•&nbsp;--doc.force_true_color_terminal<br/>•&nbsp;--doc.no-force_true_color_terminal<br/>**Variable d'environnement** : ROUGAILCLI_DOC.FORCE_TRUE_COLOR_TERMINAL | Force les vrais couleurs dans le terminal. | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | `standard` | |
feat: document commandline and environment variable
2025-11-27 22:17:17 +01:00
Initial commit
2024-07-10 21:23:57 +02:00
Reference in a new issue Copy permalink