No description
Find a file
2025-11-30 21:31:58 +01:00
locale feat: document commandline and environment variable 2025-11-27 22:17:17 +01:00
src/rougail/output_doc feat: personalise column number 2025-11-30 21:31:58 +01:00
tests feat: personalise column number 2025-11-30 21:31:58 +01:00
CHANGELOG.md bump: version 0.2.0a38 → 0.2.0a39 2025-11-21 08:15:09 +01:00
LICENSE feat: black + improvement 2024-11-01 11:45:38 +01:00
pyproject.toml bump: version 0.2.0a38 → 0.2.0a39 2025-11-21 08:15:09 +01:00
README.md feat: personalise column number 2025-11-30 21:31:58 +01:00

Table of Contents

Two columns

Générer la documentation

🛈 Informations

doc
basic désactivé
Désactivé : lorsque "Générer la documentation" n'est pas spécifié dans "Sélection pour sortie"

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.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" is json or "Contenu générer" 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" is json or "Contenu générer" 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" is json or "Contenu générer" hasn't variable or changelog
doc.environment_prefix
string standard obligatoire désactivé
Ligne de commande : -dd, --doc.environment_prefix
Variable d'environnement : ROUGAILCLI_DOC.ENVIRONMENT_PREFIX
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" 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 si 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" 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
• six_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

Three columns

Générer la documentation

🛈 Informations

doc
basic désactivé
Désactivé : lorsque "Générer la documentation" n'est pas spécifié dans "Sélection pour sortie"

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.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" is json or "Contenu générer" 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" is json or "Contenu générer" 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" is json or "Contenu générer" hasn't variable or changelog
false
doc.environment_prefix
string standard obligatoire désactivé
Ligne de commande : -dd, --doc.environment_prefix
Variable d'environnement : ROUGAILCLI_DOC.ENVIRONMENT_PREFIX
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" 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 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 si 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" 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
• six_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

Four columns

Générer la documentation

🛈 Informations

doc
basic désactivé
Désactivé : lorsque "Générer la documentation" n'est pas spécifié dans "Sélection pour sortie"

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 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 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"
string 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" is json or "Contenu générer" hasn't variable or changelog
false boolean obligatoire
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 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" is json or "Contenu générer" hasn't variable or changelog
false boolean 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" is json or "Contenu générer" hasn't variable or changelog
false boolean obligatoire
doc.environment_prefix
standard désactivé
Ligne de commande : -dd, --doc.environment_prefix
Variable d'environnement : ROUGAILCLI_DOC.ENVIRONMENT_PREFIX
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" est false
ROUGAIL string 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 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 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 si 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
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 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 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" est accessible et a la valeur "false"
30 integer 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 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
• six_columns
two_columns choice 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 obligatoire

Five columns

Générer la documentation

🛈 Informations

doc
basic désactivé
Désactivé : lorsque "Générer la documentation" n'est pas spécifié dans "Sélection pour sortie"

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 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 multiple obligatoire standard
doc.previous_json_file
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 obligatoire basic désactivé
Désactivé : changelog n'est pas sélectionné dans "Contenu générer"
doc.without_family
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 obligatoire standard désactivé
Désactivé : if "Générer le document au format" is json or "Contenu générer" 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 standard
doc.with_commandline
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 obligatoire standard désactivé
Désactivé : if "Générer le document au format" is json or "Contenu générer" hasn't variable or changelog
doc.with_environment
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 obligatoire standard désactivé
Désactivé : if "Générer le document au format" is json or "Contenu générer" hasn't variable or changelog
doc.environment_prefix
Ligne de commande : -dd, --doc.environment_prefix
Variable d'environnement : ROUGAILCLI_DOC.ENVIRONMENT_PREFIX
Nom du préfixe d'environnement par défaut.
Validateur : doit seulement utilise des caractères en majuscule
ROUGAIL string obligatoire standard désactivé
Désactivé : si "__.main_namespace" n'est pas défini ou "Ajoute les informations de variable d'environnement dans la documentation" 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 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 obligatoire basic
Variable Description Default value Type Access control
doc.disabled_modes
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 si le mode existe déjà
string multiple standard désactivé
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 obligatoire standard
doc.comment_examples
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 obligatoire standard désactivé
Désactivé : désactiver lorsqu'il example n'est pas dans contents
doc.comment_examples_column
Ligne de commande : --doc.comment_examples_column
Variable d'environnement : ROUGAILCLI_DOC.COMMENT_EXAMPLES_COLUMN
Commentaire dans les exemples commence à la colonne. 30 integer obligatoire standard désactivé
Désactivé : lorsque la variable "Ajouter la description des variables et des familles lorsqu'on génère des exemples" 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 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
• six_columns
two_columns choice 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 obligatoire standard

Six columns

Générer la documentation

🛈 Informations

doc
basic désactivé
Désactivé : lorsque "Générer la documentation" n'est pas spécifié dans "Sélection pour sortie"

Variable Description Default value Type Access control Validateur
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 obligatoire standard
doc.contents
Ligne de commande : -dc, --doc.contents
Variable d'environnement : ROUGAILCLI_DOC.CONTENTS
Contenu générer.
Choix :
• variables
• example
• changelog
• variables choice multiple obligatoire standard unique
doc.previous_json_file
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 obligatoire basic désactivé
Désactivé : changelog n'est pas sélectionné dans "Contenu générer"
doc.without_family
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 obligatoire standard désactivé
Désactivé : if "Générer le document au format" is json or "Contenu générer" 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 standard
doc.with_commandline
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 obligatoire standard désactivé
Désactivé : if "Générer le document au format" is json or "Contenu générer" hasn't variable or changelog
doc.with_environment
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 obligatoire standard désactivé
Désactivé : if "Générer le document au format" is json or "Contenu générer" hasn't variable or changelog
doc.environment_prefix
Ligne de commande : -dd, --doc.environment_prefix
Variable d'environnement : ROUGAILCLI_DOC.ENVIRONMENT_PREFIX
Nom du préfixe d'environnement par défaut. ROUGAIL string obligatoire standard désactivé
Désactivé : si "__.main_namespace" n'est pas défini ou "Ajoute les informations de variable d'environnement dans la documentation" est false
Doit seulement utilise des caractères en majuscule.

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 Validateur
doc.other_root_filenames.root_path
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 standard unique
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. UNIX filename obligatoire basic • this filename could be a relative path
• file type allowed: "fichier" et "répertoire".
Variable Description Default value Type Access control Validateur
doc.disabled_modes
Ligne de commande : --doc.disabled_modes
Variable d'environnement : ROUGAILCLI_DOC.DISABLED_MODES
Désactiver la documentation des variables avec ces modes. string multiple standard désactivé
Désactivé : désactiver lorsqu'il n'y a pas de mode valable
unique
Vérifier si le mode existe déjà.
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 obligatoire standard
doc.comment_examples
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 obligatoire standard désactivé
Désactivé : désactiver lorsqu'il example n'est pas dans contents
doc.comment_examples_column
Ligne de commande : --doc.comment_examples_column
Variable d'environnement : ROUGAILCLI_DOC.COMMENT_EXAMPLES_COLUMN
Commentaire dans les exemples commence à la colonne. 30 integer obligatoire standard désactivé
Désactivé : lorsque la variable "Ajouter la description des variables et des familles lorsqu'on génère des exemples" 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.
Choix :
• console
• asciidoc
• html
• github
• gitlab
• json
console choice obligatoire standard Le format de sortie json n'est pas compatible avec "changelog" et example" de la variable contents.
doc.table_model
Ligne de commande : -dm, --doc.table_model
Variable d'environnement : ROUGAILCLI_DOC.TABLE_MODEL
Generate document inside table model.
Choix :
• two_columns
• three_columns
• four_columns
• five_columns
• six_columns
two_columns choice obligatoire standard Le format de sortie json n'est pas compatible avec "changelog" et example" de la variable contents.
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 obligatoire standard