--- gitea: none include_toc: true --- # Two columns ## Générer la documentation > **🛈 Informations** > > **doc**\ > `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 | |--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **doc.title_level**
[`integer`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire`
**Ligne de commande** : -dt, --doc.title_level
**Variable d'environnement** : ROUGAILCLI_DOC.TITLE_LEVEL | Niveau de titre de départ.
**Défaut** : 1 | | **doc.contents**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` `standard` `obligatoire` `unique`
**Ligne de commande** : -dc, --doc.contents
**Variable d'environnement** : ROUGAILCLI_DOC.CONTENTS | Contenu générer.
**Choix** :
• variables **← (défaut)**
• example
• changelog | | **doc.previous_json_file**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` *`désactivé`*
**Ligne de commande** : -dp, --doc.previous_json_file
**Variable d'environnement** : ROUGAILCLI_DOC.PREVIOUS_JSON_FILE | Précédent fichier de description au format JSON.
**Désactivé** : changelog n'est pas sélectionné dans "[Contenu générer](#doc.contents)" | | **doc.without_family**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` *`désactivé`*
**Ligne de commande** :
• -df, --doc.without_family
• -ndf, --doc.no-without_family
**Variable d'environnement** : ROUGAILCLI_DOC.WITHOUT_FAMILY | Ne pas ajouter les familles dans la documentation.
**Défaut** : false
**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 | | **doc.root**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard`
**Ligne de commande** : -dr, --doc.root
**Variable d'environnement** : ROUGAILCLI_DOC.ROOT | Documente les variables depuis cette famille. | | **doc.with_commandline**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` *`désactivé`*
**Ligne de commande** :
• -dw, --doc.with_commandline
• -ndw, --doc.no-with_commandline
**Variable d'environnement** : ROUGAILCLI_DOC.WITH_COMMANDLINE | Ajoute les informations de la ligne de commande dans la documentation.
**Défaut** : false
**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 | | **doc.with_environment**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` *`désactivé`*
**Ligne de commande** :
• -de, --doc.with_environment
• -nde, --doc.no-with_environment
**Variable d'environnement** : ROUGAILCLI_DOC.WITH_ENVIRONMENT | Ajoute les informations de variable d'environnement dans la documentation.
**Défaut** : false
**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 | | **doc.environment_default_environment_name**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` *`désactivé`*
**Ligne de commande** : -dd, --doc.environment_default_environment_name
**Variable d'environnement** : ROUGAILCLI_DOC.ENVIRONMENT_DEFAULT_ENVIRONMENT_NAME | Nom du préfixe d'environnement par défaut.
**Validateur** : doit seulement utilise des caractères en majuscule
**Défaut** : ROUGAIL
**Désactivé** : si "__.main_namespace" n'est pas défini ou "[Ajoute les informations de variable d'environnement dans la documentation](#doc.with_environment)" est false | ## Les familles ou variables pour cette famille sont dans un autre fichier > **🛈 Informations** > > **doc.other_root_filenames**\ > Cette famille contient des listes de bloc de variable.\ > `basic` *`désactivé`*\ > **Désactivé** : documentation doit être séparée | Variable | Description | |-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------| | **doc.other_root_filenames.root_path**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` `standard` `unique`
**Ligne de commande** : --doc.other_root_filenames.root_path
**Variable d'environnement** : ROUGAILCLI_DOC.OTHER_ROOT_FILENAMES.ROOT_PATH | Nom de la famille racine. | | **doc.other_root_filenames.filename**
[`UNIX filename`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire`
**Ligne de commande** : --doc.other_root_filenames.filename
**Variable d'environnement** : ROUGAILCLI_DOC.OTHER_ROOT_FILENAMES.FILENAME | Nom du fichier.
**Validateurs** :
• this filename could be a relative path
• file type allowed: "fichier" et "répertoire" | | Variable | Description | |---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **doc.disabled_modes**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` `standard` *`désactivé`* `unique`
**Ligne de commande** : --doc.disabled_modes
**Variable d'environnement** : ROUGAILCLI_DOC.DISABLED_MODES | Désactiver la documentation des variables avec ces modes.
**Validateur** : vérifier le mode existe déjà
**Désactivé** : désactiver lorsqu'il n'y a pas de mode valable | | **doc.change_default_value**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire`
**Ligne de commande** :
• --doc.change_default_value
• --doc.no-change_default_value
**Variable d'environnement** : ROUGAILCLI_DOC.CHANGE_DEFAULT_VALUE | Valeurs modifiées pour documenter les familles leader ou dynamique.
**Défaut** : true | | **doc.comment_examples**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` *`désactivé`*
**Ligne de commande** :
• -dx, --doc.comment_examples
• -ndx, --doc.no-comment_examples
**Variable d'environnement** : ROUGAILCLI_DOC.COMMENT_EXAMPLES | Ajouter la description des variables et des familles lorsqu'on génère des exemples.
**Défaut** : false
**Désactivé** : désactiver lorsqu'il example n'est pas dans contents | | **doc.comment_examples_column**
[`integer`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` *`désactivé`*
**Ligne de commande** : --doc.comment_examples_column
**Variable d'environnement** : ROUGAILCLI_DOC.COMMENT_EXAMPLES_COLUMN | Commentaire dans les exemples commence à la colonne.
**Défaut** : 30
**Désactivé** : lorsque la variable "[Ajouter la description des variables et des familles lorsqu'on génère des exemples](#doc.comment_examples)" est accessible et a la valeur "false" | | **doc.output_format**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire`
**Ligne de commande** : -do, --doc.output_format
**Variable d'environnement** : ROUGAILCLI_DOC.OUTPUT_FORMAT | Générer le document au format.
**Validateur** : le format de sortie json n'est pas compatible avec "changelog" et example" de la variable contents
**Choix** :
• console **← (défaut)**
• asciidoc
• html
• github
• gitlab
• json | | **doc.table_model**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire`
**Ligne de commande** : -dm, --doc.table_model
**Variable d'environnement** : ROUGAILCLI_DOC.TABLE_MODEL | Generate document inside table model.
**Validateur** : le format de sortie json n'est pas compatible avec "changelog" et example" de la variable contents
**Choix** :
• two_columns **← (défaut)**
• three_columns
• four_columns
• five_columns | | **doc.force_true_color_terminal**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire`
**Ligne de commande** :
• --doc.force_true_color_terminal
• --doc.no-force_true_color_terminal
**Variable d'environnement** : ROUGAILCLI_DOC.FORCE_TRUE_COLOR_TERMINAL | Force les vrais couleurs dans le terminal.
**Défaut** : false | # Three columns ## Générer la documentation > **🛈 Informations** > > **doc**\ > `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 | |--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------| | **doc.title_level**
[`integer`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire`
**Ligne de commande** : -dt, --doc.title_level
**Variable d'environnement** : ROUGAILCLI_DOC.TITLE_LEVEL | Niveau de titre de départ. | 1 | | **doc.contents**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` `standard` `obligatoire` `unique`
**Ligne de commande** : -dc, --doc.contents
**Variable d'environnement** : ROUGAILCLI_DOC.CONTENTS | Contenu générer.
**Choix** :
• variables
• example
• changelog |
• variables | | **doc.previous_json_file**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` *`désactivé`*
**Ligne de commande** : -dp, --doc.previous_json_file
**Variable d'environnement** : ROUGAILCLI_DOC.PREVIOUS_JSON_FILE | Précédent fichier de description au format JSON.
**Désactivé** : changelog n'est pas sélectionné dans "[Contenu générer](#doc.contents)" | | | **doc.without_family**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` *`désactivé`*
**Ligne de commande** :
• -df, --doc.without_family
• -ndf, --doc.no-without_family
**Variable d'environnement** : ROUGAILCLI_DOC.WITHOUT_FAMILY | Ne pas ajouter les familles dans la documentation.
**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 | | **doc.root**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard`
**Ligne de commande** : -dr, --doc.root
**Variable d'environnement** : ROUGAILCLI_DOC.ROOT | Documente les variables depuis cette famille. | | | **doc.with_commandline**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` *`désactivé`*
**Ligne de commande** :
• -dw, --doc.with_commandline
• -ndw, --doc.no-with_commandline
**Variable d'environnement** : ROUGAILCLI_DOC.WITH_COMMANDLINE | Ajoute les informations de la ligne de commande dans la documentation.
**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 | | **doc.with_environment**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` *`désactivé`*
**Ligne de commande** :
• -de, --doc.with_environment
• -nde, --doc.no-with_environment
**Variable d'environnement** : ROUGAILCLI_DOC.WITH_ENVIRONMENT | Ajoute les informations de variable d'environnement dans la documentation.
**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 | | **doc.environment_default_environment_name**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` *`désactivé`*
**Ligne de commande** : -dd, --doc.environment_default_environment_name
**Variable d'environnement** : ROUGAILCLI_DOC.ENVIRONMENT_DEFAULT_ENVIRONMENT_NAME | Nom du préfixe d'environnement par défaut.
**Validateur** : doit seulement utilise des caractères en majuscule
**Désactivé** : si "__.main_namespace" n'est pas défini ou "[Ajoute les informations de variable d'environnement dans la documentation](#doc.with_environment)" est false | ROUGAIL | ## Les familles ou variables pour cette famille sont dans un autre fichier > **🛈 Informations** > > **doc.other_root_filenames**\ > Cette famille contient des listes de bloc de variable.\ > `basic` *`désactivé`*\ > **Désactivé** : documentation doit être séparée | Variable | Description | |-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------| | **doc.other_root_filenames.root_path**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` `standard` `unique`
**Ligne de commande** : --doc.other_root_filenames.root_path
**Variable d'environnement** : ROUGAILCLI_DOC.OTHER_ROOT_FILENAMES.ROOT_PATH | Nom de la famille racine. | | **doc.other_root_filenames.filename**
[`UNIX filename`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire`
**Ligne de commande** : --doc.other_root_filenames.filename
**Variable d'environnement** : ROUGAILCLI_DOC.OTHER_ROOT_FILENAMES.FILENAME | Nom du fichier.
**Validateurs** :
• this filename could be a relative path
• file type allowed: "fichier" et "répertoire" | | Variable | Description | Default value | |---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------| | **doc.disabled_modes**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` `standard` *`désactivé`* `unique`
**Ligne de commande** : --doc.disabled_modes
**Variable d'environnement** : ROUGAILCLI_DOC.DISABLED_MODES | Désactiver la documentation des variables avec ces modes.
**Validateur** : vérifier le mode existe déjà
**Désactivé** : désactiver lorsqu'il n'y a pas de mode valable | | | **doc.change_default_value**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire`
**Ligne de commande** :
• --doc.change_default_value
• --doc.no-change_default_value
**Variable d'environnement** : ROUGAILCLI_DOC.CHANGE_DEFAULT_VALUE | Valeurs modifiées pour documenter les familles leader ou dynamique. | true | | **doc.comment_examples**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` *`désactivé`*
**Ligne de commande** :
• -dx, --doc.comment_examples
• -ndx, --doc.no-comment_examples
**Variable d'environnement** : ROUGAILCLI_DOC.COMMENT_EXAMPLES | Ajouter la description des variables et des familles lorsqu'on génère des exemples.
**Désactivé** : désactiver lorsqu'il example n'est pas dans contents | false | | **doc.comment_examples_column**
[`integer`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` *`désactivé`*
**Ligne de commande** : --doc.comment_examples_column
**Variable d'environnement** : ROUGAILCLI_DOC.COMMENT_EXAMPLES_COLUMN | Commentaire dans les exemples commence à la colonne.
**Désactivé** : lorsque la variable "[Ajouter la description des variables et des familles lorsqu'on génère des exemples](#doc.comment_examples)" est accessible et a la valeur "false" | 30 | | **doc.output_format**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire`
**Ligne de commande** : -do, --doc.output_format
**Variable d'environnement** : ROUGAILCLI_DOC.OUTPUT_FORMAT | Générer le document au format.
**Validateur** : le format de sortie json n'est pas compatible avec "changelog" et example" de la variable contents
**Choix** :
• console
• asciidoc
• html
• github
• gitlab
• json | console | | **doc.table_model**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire`
**Ligne de commande** : -dm, --doc.table_model
**Variable d'environnement** : ROUGAILCLI_DOC.TABLE_MODEL | Generate document inside table model.
**Validateur** : le format de sortie json n'est pas compatible avec "changelog" et example" de la variable contents
**Choix** :
• two_columns
• three_columns
• four_columns
• five_columns | two_columns | | **doc.force_true_color_terminal**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire`
**Ligne de commande** :
• --doc.force_true_color_terminal
• --doc.no-force_true_color_terminal
**Variable d'environnement** : ROUGAILCLI_DOC.FORCE_TRUE_COLOR_TERMINAL | Force les vrais couleurs dans le terminal. | false | # Four columns ## Générer la documentation > **🛈 Informations** > > **doc**\ > `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 | |-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------|-------------------------------------------------------------------------------------------------------------| | **doc.title_level**
`standard`
**Ligne de commande** : -dt, --doc.title_level
**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` | | **doc.contents**
`standard` `unique`
**Ligne de commande** : -dc, --doc.contents
**Variable d'environnement** : ROUGAILCLI_DOC.CONTENTS | Contenu générer.
**Choix** :
• variables
• example
• changelog |
• variables | [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` `obligatoire` | | **doc.previous_json_file**
`basic` *`désactivé`*
**Ligne de commande** : -dp, --doc.previous_json_file
**Variable d'environnement** : ROUGAILCLI_DOC.PREVIOUS_JSON_FILE | Précédent fichier de description au format JSON.
**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` | | **doc.without_family**
`standard` *`désactivé`*
**Ligne de commande** :
• -df, --doc.without_family
• -ndf, --doc.no-without_family
**Variable d'environnement** : ROUGAILCLI_DOC.WITHOUT_FAMILY | Ne pas ajouter les familles dans la documentation.
**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` | | **doc.root**
`standard`
**Ligne de commande** : -dr, --doc.root
**Variable d'environnement** : ROUGAILCLI_DOC.ROOT | Documente les variables depuis cette famille. | | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) | | **doc.with_commandline**
`standard` *`désactivé`*
**Ligne de commande** :
• -dw, --doc.with_commandline
• -ndw, --doc.no-with_commandline
**Variable d'environnement** : ROUGAILCLI_DOC.WITH_COMMANDLINE | Ajoute les informations de la ligne de commande dans la documentation.
**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` | | **doc.with_environment**
`standard` *`désactivé`*
**Ligne de commande** :
• -de, --doc.with_environment
• -nde, --doc.no-with_environment
**Variable d'environnement** : ROUGAILCLI_DOC.WITH_ENVIRONMENT | Ajoute les informations de variable d'environnement dans la documentation.
**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` | | **doc.environment_default_environment_name**
`standard` *`désactivé`*
**Ligne de commande** : -dd, --doc.environment_default_environment_name
**Variable d'environnement** : ROUGAILCLI_DOC.ENVIRONMENT_DEFAULT_ENVIRONMENT_NAME | Nom du préfixe d'environnement par défaut.
**Validateur** : doit seulement utilise des caractères en majuscule
**Désactivé** : si "__.main_namespace" n'est pas défini ou "[Ajoute les informations de variable d'environnement dans la documentation](#doc.with_environment)" est false | ROUGAIL | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | ## Les familles ou variables pour cette famille sont dans un autre fichier > **🛈 Informations** > > **doc.other_root_filenames**\ > Cette famille contient des listes de bloc de variable.\ > `basic` *`désactivé`*\ > **Désactivé** : documentation doit être séparée | Variable | Description | Type | |---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------| | **doc.other_root_filenames.root_path**
`standard` `unique`
**Ligne de commande** : --doc.other_root_filenames.root_path
**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` | | **doc.other_root_filenames.filename**
`basic`
**Ligne de commande** : --doc.other_root_filenames.filename
**Variable d'environnement** : ROUGAILCLI_DOC.OTHER_ROOT_FILENAMES.FILENAME | Nom du fichier.
**Validateurs** :
• this filename could be a relative path
• 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 | |-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------|---------------------------------------------------------------------------------------------------| | **doc.disabled_modes**
`standard` *`désactivé`* `unique`
**Ligne de commande** : --doc.disabled_modes
**Variable d'environnement** : ROUGAILCLI_DOC.DISABLED_MODES | Désactiver la documentation des variables avec ces modes.
**Validateur** : vérifier le mode existe déjà
**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` | | **doc.change_default_value**
`standard`
**Ligne de commande** :
• --doc.change_default_value
• --doc.no-change_default_value
**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` | | **doc.comment_examples**
`standard` *`désactivé`*
**Ligne de commande** :
• -dx, --doc.comment_examples
• -ndx, --doc.no-comment_examples
**Variable d'environnement** : ROUGAILCLI_DOC.COMMENT_EXAMPLES | Ajouter la description des variables et des familles lorsqu'on génère des exemples.
**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` | | **doc.comment_examples_column**
`standard` *`désactivé`*
**Ligne de commande** : --doc.comment_examples_column
**Variable d'environnement** : ROUGAILCLI_DOC.COMMENT_EXAMPLES_COLUMN | Commentaire dans les exemples commence à la colonne.
**Désactivé** : lorsque la variable "[Ajouter la description des variables et des familles lorsqu'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` | | **doc.output_format**
`standard`
**Ligne de commande** : -do, --doc.output_format
**Variable d'environnement** : ROUGAILCLI_DOC.OUTPUT_FORMAT | Générer le document au format.
**Validateur** : le format de sortie json n'est pas compatible avec "changelog" et example" de la variable contents
**Choix** :
• console
• asciidoc
• html
• github
• gitlab
• json | console | [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | | **doc.table_model**
`standard`
**Ligne de commande** : -dm, --doc.table_model
**Variable d'environnement** : ROUGAILCLI_DOC.TABLE_MODEL | Generate document inside table model.
**Validateur** : le format de sortie json n'est pas compatible avec "changelog" et example" de la variable contents
**Choix** :
• two_columns
• three_columns
• four_columns
• five_columns | two_columns | [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | | **doc.force_true_color_terminal**
`standard`
**Ligne de commande** :
• --doc.force_true_color_terminal
• --doc.no-force_true_color_terminal
**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 le mode! le mode! le mode! le mode! le mode! le mode! le mode! le mode! le mode! le mode! le mode! le mode! le mode! le mode! le mode! le mode! le mode! ## Générer la documentation > **🛈 Informations** > > **doc**\ > `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 | |--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------|-----------------------|-------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **doc.title_level**
**Ligne de commande** : -dt, --doc.title_level
**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` | | **doc.contents**
`unique`
**Ligne de commande** : -dc, --doc.contents
**Variable d'environnement** : ROUGAILCLI_DOC.CONTENTS | Contenu générer.
**Choix** :
• variables
• example
• changelog |
• variables | [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` `obligatoire` | `standard` | | **doc.previous_json_file**
*`désactivé`*
**Ligne de commande** : -dp, --doc.previous_json_file
**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é** : changelog n'est pas sélectionné dans "[Contenu générer](#doc.contents)" | | **doc.without_family**
*`désactivé`*
**Ligne de commande** :
• -df, --doc.without_family
• -ndf, --doc.no-without_family
**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é** : 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 | | **doc.root**
**Ligne de commande** : -dr, --doc.root
**Variable d'environnement** : ROUGAILCLI_DOC.ROOT | Documente les variables depuis cette famille. | | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) | `standard` | | **doc.with_commandline**
*`désactivé`*
**Ligne de commande** :
• -dw, --doc.with_commandline
• -ndw, --doc.no-with_commandline
**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é** : 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 | | **doc.with_environment**
*`désactivé`*
**Ligne de commande** :
• -de, --doc.with_environment
• -nde, --doc.no-with_environment
**Variable d'environnement** : ROUGAILCLI_DOC.WITH_ENVIRONMENT | Ajoute les informations de variable d'environnement dans la documentation. | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | `standard`
**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 | | **doc.environment_default_environment_name**
*`désactivé`*
**Ligne de commande** : -dd, --doc.environment_default_environment_name
**Variable d'environnement** : ROUGAILCLI_DOC.ENVIRONMENT_DEFAULT_ENVIRONMENT_NAME | Nom du préfixe d'environnement par défaut.
**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é** : si "__.main_namespace" n'est pas défini ou "[Ajoute les informations de variable d'environnement dans la documentation](#doc.with_environment)" est false | ## Les familles ou variables pour cette famille sont dans un autre fichier > **🛈 Informations** > > **doc.other_root_filenames**\ > 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 | |----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------|------------------| | **doc.other_root_filenames.root_path**
`unique`
**Ligne de commande** : --doc.other_root_filenames.root_path
**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` | | **doc.other_root_filenames.filename**
**Ligne de commande** : --doc.other_root_filenames.filename
**Variable d'environnement** : ROUGAILCLI_DOC.OTHER_ROOT_FILENAMES.FILENAME | Nom du fichier.
**Validateurs** :
• this filename could be a relative path
• 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 | |----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------|---------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **doc.disabled_modes**
*`désactivé`* `unique`
**Ligne de commande** : --doc.disabled_modes
**Variable d'environnement** : ROUGAILCLI_DOC.DISABLED_MODES | Désactiver la documentation des variables avec ces modes.
**Validateur** : vérifier le mode existe déjà | | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` | `standard`
**Désactivé** : désactiver lorsqu'il n'y a pas de mode valable | | **doc.change_default_value**
**Ligne de commande** :
• --doc.change_default_value
• --doc.no-change_default_value
**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` | | **doc.comment_examples**
*`désactivé`*
**Ligne de commande** :
• -dx, --doc.comment_examples
• -ndx, --doc.no-comment_examples
**Variable d'environnement** : ROUGAILCLI_DOC.COMMENT_EXAMPLES | Ajouter la description des variables et des familles lorsqu'on génère des exemples. | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | `standard`
**Désactivé** : désactiver lorsqu'il example n'est pas dans contents | | **doc.comment_examples_column**
*`désactivé`*
**Ligne de commande** : --doc.comment_examples_column
**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é** : lorsque la variable "[Ajouter la description des variables et des familles lorsqu'on génère des exemples](#doc.comment_examples)" est accessible et a la valeur "false" | | **doc.output_format**
**Ligne de commande** : -do, --doc.output_format
**Variable d'environnement** : ROUGAILCLI_DOC.OUTPUT_FORMAT | Générer le document au format.
**Validateur** : le format de sortie json n'est pas compatible avec "changelog" et example" de la variable contents
**Choix** :
• console
• asciidoc
• html
• github
• gitlab
• json | console | [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | `standard` | | **doc.table_model**
**Ligne de commande** : -dm, --doc.table_model
**Variable d'environnement** : ROUGAILCLI_DOC.TABLE_MODEL | Generate document inside table model.
**Validateur** : le format de sortie json n'est pas compatible avec "changelog" et example" de la variable contents
**Choix** :
• two_columns
• three_columns
• four_columns
• five_columns | two_columns | [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | `standard` | | **doc.force_true_color_terminal**
**Ligne de commande** :
• --doc.force_true_color_terminal
• --doc.no-force_true_color_terminal
**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` |