# 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` `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` `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` `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` `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` `standard`
**Ligne de commande** : -dr, --doc.root
**Variable d'environnement** : ROUGAILCLI_DOC.ROOT | Documente les variables depuis cette famille. | | **doc.with_commandline**
`boolean` `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` `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` `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` `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` `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` `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` `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` `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` `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` `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` `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` `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 | # 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` `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` `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` `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` `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` `standard`
**Ligne de commande** : -dr, --doc.root
**Variable d'environnement** : ROUGAILCLI_DOC.ROOT | Documente les variables depuis cette famille. | | | **doc.with_commandline**
`boolean` `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` `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` `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 | Default value | |-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------|-----------------| | **doc.other_root_filenames.root_path**
`string` `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` `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` `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` `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` `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` `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` `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` `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` `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 | # 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` `obligatoire`
**Ligne de commande** : -dt, --doc.title_level
**Variable d'environnement** : ROUGAILCLI_DOC.TITLE_LEVEL | Niveau de titre de départ. | 1 | `integer` | | **doc.contents**
`standard` `obligatoire` `unique`
**Ligne de commande** : -dc, --doc.contents
**Variable d'environnement** : ROUGAILCLI_DOC.CONTENTS | Contenu générer.
**Choix** :
• variables
• example
• changelog |
• variables | `choice` `multiple` | | **doc.previous_json_file**
`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)" | | `string` | | **doc.without_family**
`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 | `boolean` | | **doc.root**
`standard`
**Ligne de commande** : -dr, --doc.root
**Variable d'environnement** : ROUGAILCLI_DOC.ROOT | Documente les variables depuis cette famille. | | `string` | | **doc.with_commandline**
`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 | `boolean` | | **doc.with_environment**
`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 | `boolean` | | **doc.environment_default_environment_name**
`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 | `string` | # 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 | Default value | 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` `multiple` | | **doc.other_root_filenames.filename**
`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" | | `UNIX filename` | | 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` `multiple` | | **doc.change_default_value**
`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 | `boolean` | | **doc.comment_examples**
`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 | `boolean` | | **doc.comment_examples_column**
`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 | `integer` | | **doc.output_format**
`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 | `choice` | | **doc.table_model**
`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 | `choice` | | **doc.force_true_color_terminal**
`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 | `boolean` | # 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` `obligatoire`
**Ligne de commande** : -dt, --doc.title_level
**Variable d'environnement** : ROUGAILCLI_DOC.TITLE_LEVEL | Niveau de titre de départ. | 1 | `integer` | | **doc.contents**
`standard` `obligatoire` `unique`
**Ligne de commande** : -dc, --doc.contents
**Variable d'environnement** : ROUGAILCLI_DOC.CONTENTS | Contenu générer.
**Choix** :
• variables
• example
• changelog |
• variables | `choice` `multiple` | | **doc.previous_json_file**
`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. | | `string` | | **doc.without_family**
`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. | false | `boolean` | | **doc.root**
`standard`
**Ligne de commande** : -dr, --doc.root
**Variable d'environnement** : ROUGAILCLI_DOC.ROOT | Documente les variables depuis cette famille. | | `string` | | **doc.with_commandline**
`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. | false | `boolean` | | **doc.with_environment**
`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. | false | `boolean` | | **doc.environment_default_environment_name**
`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 | ROUGAIL | `string` | # 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 | Default value | 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` `multiple` | | **doc.other_root_filenames.filename**
`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" | | `UNIX filename` | | 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à | | `string` `multiple` | | **doc.change_default_value**
`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 | `boolean` | | **doc.comment_examples**
`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. | false | `boolean` | | **doc.comment_examples_column**
`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. | 30 | `integer` | | **doc.output_format**
`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 | `choice` | | **doc.table_model**
`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 | `choice` | | **doc.force_true_color_terminal**
`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 | `boolean` |