rougail-output-doc/README.fr.md

Table of Contents

• Générer la documentation depuis les fichiers de structure
• Les variables pour cette famille sont documentés dans un autre fichier
• Documentation des variables et journal de changements
• Documentation du journal des changements
• Configuration des exemples

🇬🇧 (EN) - 🇫🇷 (FR)

Générer la documentation depuis les fichiers de structure

🛈 Informations

Les fichiers de structure contiennent toutes les informations relatif aux variables. Cette sortie génère la documentation pour tout ou partie de ces variables.
Chemin : doc
désactivé
Désactivé : si doc n'est pas spécifié dans "Sélection pour sortie"

Variable	Description	Valeur par défaut	Type	Contrôle des accès	Validateur
doc.output_format Ligne de commande : -do, --doc.output_format Variable d'environnement : ROUGAILCLI_DOC.OUTPUT_FORMAT	Le format de sortie de la documentation générée.	console	choice obligatoire		Choix : • console • asciidoc • html • github • gitlab • json
doc.tabular_template Ligne de commande : -dm, --doc.tabular_template Variable d'environnement : ROUGAILCLI_DOC.TABULAR_TEMPLATE	Génère la documentation avec ce modèle de tableau. Les variables sont documentées avec une vue tableau. Une sélection de modèle vous permet de choisir le contenu de chaque colonne.	two_columns	choice obligatoire	désactivé Désactivé : "Le format de sortie de la documentation générée" en json n'est pas compatible avec cette variable	Choix : • two_columns • three_columns • four_columns • five_columns • six_columns
doc.contents Ligne de commande : -dc, --doc.contents Variable d'environnement : ROUGAILCLI_DOC.CONTENTS	Contenu généré. Vous pouvez générer trois type de documentation. Toutes les variables ("variables"), un exemple de fichier au format YAML ("example") ou le journal des changements ("changelog").	• variables	choice multiple obligatoire	cachée Cachée : "Le format de sortie de la documentation générée" en json n'est pas compatible avec "Contenu généré" changelog or example	unique Choix : • variables • example • changelog
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
doc.default_values Ligne de commande : • --doc.default_values • --doc.no-default_values Variable d'environnement : ROUGAILCLI_DOC.DEFAULT_VALUES	Modifier les valeurs pour documenter toutes les variables. Pour documenter les variables des leadership ou des familles dynamiques, il est parfois nécessaire de générer des valeurs, qui peuvent modifier les valeurs de la configuration. Soyez vigilent si vous réutilisez cette configuration.	true	boolean obligatoire
doc.true_color Ligne de commande : • --doc.true_color • --doc.no-true_color Variable d'environnement : ROUGAILCLI_DOC.TRUE_COLOR	Afficher la documentation dans la console en permanence avec un terminal en couleurs réelles.	false	boolean obligatoire	désactivé Désactivé : lorsque la variable "Le format de sortie de la documentation générée" n'a pas la valeur "console"
doc.root Ligne de commande : -dr, --doc.root Variable d'environnement : ROUGAILCLI_DOC.ROOT	Documenter les variables enfants de cette famille. Par défaut, toute les variables accessibles sont incluent dans la documentation. Il est possible de définir une famille a partir de laquelle la documentation doit être générée.		string

Les variables pour cette famille sont documentés dans un autre fichier

🛈 Informations

Si vous séparez les variables dans différents fichiers, le lien entre les variables va être cassé. Dans ce cas, vous devez définit différents nom de fichiers pour les fichiers contenant ces variables.
Cette famille contient des listes de bloc de variable.
Chemin : doc.other_root_filenames
désactivé
Désactivé : lorsque la variable "Documenter les variables enfants de cette famille" a la valeur "null"

Variable	Description	Type	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	Ce fichier contient les variables enfants de la famille.	string multiple	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	• this filename could be a relative path • file type allowed: "file".

Documentation des variables et journal de changements

🛈 Informations

Chemin : doc.tabulars
désactivé
Désactivé : si "Le format de sortie de la documentation générée" en json ou si "Contenu généré" n'est pas variables ou changelog

Variable	Description	Valeur par défaut	Type	Contrôle des accès	Validateur
doc.tabulars.without_family Ligne de commande : • -df, --doc.tabulars.without_family • -ndf, --doc.tabulars.no-without_family Variable d'environnement : ROUGAILCLI_DOC.TABULARS.WITHOUT_FAMILY	Ne pas ajouter les familles dans la documentation.	false	boolean obligatoire
doc.tabulars.with_commandline Ligne de commande : • -dw, --doc.tabulars.with_commandline • -ndw, --doc.tabulars.no-with_commandline Variable d'environnement : ROUGAILCLI_DOC.TABULARS.WITH_COMMANDLINE	Ajoute les informations de la ligne de commande dans la documentation.	false	boolean obligatoire
doc.tabulars.with_environment Ligne de commande : • -de, --doc.tabulars.with_environment • -nde, --doc.tabulars.no-with_environment Variable d'environnement : ROUGAILCLI_DOC.TABULARS.WITH_ENVIRONMENT	Ajoute les informations de variable d'environnement dans la documentation.	false	boolean obligatoire
doc.tabulars.environment_prefix Ligne de commande : -dv, --doc.tabulars.environment_prefix Variable d'environnement : ROUGAILCLI_DOC.TABULARS.ENVIRONMENT_PREFIX	Préfixe du nom des variables d'environnement.	ROUGAIL	string obligatoire	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.

Documentation du journal des changements

🛈 Informations

Chemin : doc.changelog
désactivé
Désactivé : changelog n'est pas défini dans "Contenu généré"

Variable	Description	Type
doc.changelog.previous_json_file Ligne de commande : -dp, --doc.changelog.previous_json_file Variable d'environnement : ROUGAILCLI_DOC.CHANGELOG.PREVIOUS_JSON_FILE	Précédent fichier de description au format JSON. Pour générer le journal des changements, vous devez comparer l'ancienne liste des variables (au format json) avec les variables courantes.	string obligatoire

Configuration des exemples

🛈 Informations

Chemin : doc.examples
désactivé
Désactivé : si example n'est pas défini dans "Contenu généré"

Variable	Description	Valeur par défaut	Type	Contrôle des accès
doc.examples.comment Ligne de commande : • -dx, --doc.examples.comment • -ndx, --doc.examples.no-comment Variable d'environnement : ROUGAILCLI_DOC.EXAMPLES.COMMENT	Ajouter la description des variables et des familles lorsqu'on génère des exemples.	false	boolean obligatoire
doc.examples.comment_column Ligne de commande : --doc.examples.comment_column Variable d'environnement : ROUGAILCLI_DOC.EXAMPLES.COMMENT_COLUMN	Commentaire dans les exemples commence à la colonne.	30	integer obligatoire	désactivé Désactivé : lorsque la variable "Ajouter la description des variables et des familles lorsqu'on génère des exemples" a la valeur "false"