fix: better documentation
This commit is contained in:
parent
948e0b49ed
commit
abe492c178
8 changed files with 150 additions and 152 deletions
52
README.fr.md
52
README.fr.md
|
|
@ -6,7 +6,7 @@ include_toc: true
|
|||
|
||||
## Générer la documentation depuis les fichiers de structure
|
||||
|
||||
> **🛈 Informations**
|
||||
> [!NOTE]
|
||||
>
|
||||
> 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\
|
||||
|
|
@ -14,18 +14,18 @@ include_toc: true
|
|||
> **Désactivé** : si doc n'est pas spécifié dans "[Sélection pour sortie](#step.output)"
|
||||
|
||||
| Variable | Description | Valeur par défaut | Type | Contrôle des accès | Validateur |
|
||||
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------|-------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| **<a id="doc.output_format" name="doc.output_format">doc.output_format</a>**<br/>**Ligne de commande** : -do, --doc.output_format<br/>**Variable d'environnement** : ROUGAILCLI_DOC.OUTPUT_FORMAT | Le format de sortie de la documentation générée. | console | [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | | **Choix** : <br/>• console<br/>• asciidoc<br/>• html<br/>• github<br/>• gitlab<br/>• json |
|
||||
| **<a id="doc.tabular_template" name="doc.tabular_template">doc.tabular_template</a>**<br/>**Ligne de commande** : -dm, --doc.tabular_template<br/>**Variable d'environnement** : ROUGAILCLI_DOC.TABULAR_TEMPLATE | Génère la documentation avec ce modèle de tableau.<br/>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`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | *`désactivé`*<br/>**Désactivé** : "[Le format de sortie de la documentation générée](#doc.output_format)" en json n\'est pas compatible avec cette variable<br/> | **Choix** : <br/>• two_columns<br/>• three_columns<br/>• four_columns<br/>• five_columns<br/>• six_columns |
|
||||
| **<a id="doc.contents" name="doc.contents">doc.contents</a>**<br/>**Ligne de commande** : -dc, --doc.contents<br/>**Variable d'environnement** : ROUGAILCLI_DOC.CONTENTS | Contenu généré.<br/>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`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` `obligatoire` | *`cachée`*<br/>**Cachée** : "[Le format de sortie de la documentation générée](#doc.output_format)" en json n'est pas compatible avec "[Contenu généré](#doc.contents)" changelog or example<br/> | `unique`<br/>**Choix** : <br/>• variables<br/>• example<br/>• changelog |
|
||||
| **<a id="doc.title_level" name="doc.title_level">doc.title_level</a>**<br/>**Ligne de commande** : -dt, --doc.title_level<br/>**Variable d'environnement** : ROUGAILCLI_DOC.TITLE_LEVEL | Niveau de titre de départ. | 1 | [`integer`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | | |
|
||||
| **<a id="doc.default_values" name="doc.default_values">doc.default_values</a>**<br/>**Ligne de commande** : <br/>• --doc.default_values<br/>• --doc.no-default_values<br/>**Variable d'environnement** : ROUGAILCLI_DOC.DEFAULT_VALUES | Modifier les valeurs pour documenter toutes les variables.<br/>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`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | | |
|
||||
| **<a id="doc.true_color" name="doc.true_color">doc.true_color</a>**<br/>**Ligne de commande** : <br/>• --doc.true_color<br/>• --doc.no-true_color<br/>**Variable d'environnement** : ROUGAILCLI_DOC.TRUE_COLOR | Afficher la documentation dans la console en permanence avec un terminal en couleurs réelles. | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | *`désactivé`*<br/>**Désactivé** : lorsque la variable "[Le format de sortie de la documentation générée](#doc.output_format)" n'a pas la valeur "console" | |
|
||||
| **<a id="doc.root" name="doc.root">doc.root</a>**<br/>**Ligne de commande** : -dr, --doc.root<br/>**Variable d'environnement** : ROUGAILCLI_DOC.ROOT | Documenter les variables enfants de cette famille.<br/>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`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) | | |
|
||||
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------|-------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| **<a id="doc.output_format" name="doc.output_format">doc.output_format</a>**<br/>**Ligne de commande** : -do, --doc.output_format<br/>**Variable d'environnement** : DOC.OUTPUT_FORMAT | Le format de sortie de la documentation générée. | console | [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | | **Choix** : <br/>• console<br/>• asciidoc<br/>• html<br/>• github<br/>• gitlab<br/>• json |
|
||||
| **<a id="doc.tabular_template" name="doc.tabular_template">doc.tabular_template</a>**<br/>**Ligne de commande** : -dm, --doc.tabular_template<br/>**Variable d'environnement** : DOC.TABULAR_TEMPLATE | Génère la documentation avec ce modèle de tableau.<br/>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`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | *`désactivé`*<br/>**Désactivé** : "[Le format de sortie de la documentation générée](#doc.output_format)" en json n\'est pas compatible avec cette variable<br/> | **Choix** : <br/>• two_columns<br/>• three_columns<br/>• four_columns<br/>• five_columns<br/>• six_columns |
|
||||
| **<a id="doc.contents" name="doc.contents">doc.contents</a>**<br/>**Ligne de commande** : -dc, --doc.contents<br/>**Variable d'environnement** : DOC.CONTENTS | Contenu généré.<br/>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`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` `obligatoire` | *`cachée`*<br/>**Cachée** : "[Le format de sortie de la documentation générée](#doc.output_format)" en json n'est pas compatible avec "[Contenu généré](#doc.contents)" changelog or example<br/> | `unique`<br/>**Choix** : <br/>• variables<br/>• example<br/>• changelog |
|
||||
| **<a id="doc.title_level" name="doc.title_level">doc.title_level</a>**<br/>**Ligne de commande** : -dt, --doc.title_level<br/>**Variable d'environnement** : DOC.TITLE_LEVEL | Niveau de titre de départ. | 1 | [`integer`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | | |
|
||||
| **<a id="doc.default_values" name="doc.default_values">doc.default_values</a>**<br/>**Ligne de commande** : <br/>• --doc.default_values<br/>• --doc.no-default_values<br/>**Variable d'environnement** : DOC.DEFAULT_VALUES | Modifier les valeurs pour documenter toutes les variables.<br/>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`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | | |
|
||||
| **<a id="doc.true_color" name="doc.true_color">doc.true_color</a>**<br/>**Ligne de commande** : <br/>• --doc.true_color<br/>• --doc.no-true_color<br/>**Variable d'environnement** : DOC.TRUE_COLOR | Afficher la documentation dans la console en permanence avec un terminal en couleurs réelles. | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | *`désactivé`*<br/>**Désactivé** : lorsque la variable "[Le format de sortie de la documentation générée](#doc.output_format)" n'a pas la valeur "console" | |
|
||||
| **<a id="doc.root" name="doc.root">doc.root</a>**<br/>**Ligne de commande** : -dr, --doc.root<br/>**Variable d'environnement** : DOC.ROOT | Documenter les variables enfants de cette famille.<br/>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`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) | | |
|
||||
|
||||
### Les variables pour cette famille sont documentés dans un autre fichier
|
||||
|
||||
> **🛈 Informations**
|
||||
> [!NOTE]
|
||||
>
|
||||
> 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.\
|
||||
|
|
@ -34,48 +34,48 @@ include_toc: true
|
|||
> **Désactivé** : lorsque la variable "[Documenter les variables enfants de cette famille](#doc.root)" a la valeur "null"
|
||||
|
||||
| Variable | Description | Type | Validateur |
|
||||
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------|---------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------|
|
||||
| **<a id="doc.other_root_filenames.root_path" name="doc.other_root_filenames.root_path">doc.other_root_filenames.root_path</a>**<br/>**Ligne de commande** : --doc.other_root_filenames.root_path<br/>**Variable d'environnement** : ROUGAILCLI_DOC.OTHER_ROOT_FILENAMES.ROOT_PATH | Ce fichier contient les variables enfants de la famille. | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` | `unique` |
|
||||
| **<a id="doc.other_root_filenames.filename" name="doc.other_root_filenames.filename">doc.other_root_filenames.filename</a>**<br/>**Ligne de commande** : --doc.other_root_filenames.filename<br/>**Variable d'environnement** : ROUGAILCLI_DOC.OTHER_ROOT_FILENAMES.FILENAME | Nom du fichier. | [`UNIX filename`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | • this filename could be a relative path<br/>• file type allowed: "file". |
|
||||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------|---------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------|
|
||||
| **<a id="doc.other_root_filenames.root_path" name="doc.other_root_filenames.root_path">doc.other_root_filenames.root_path</a>**<br/>**Ligne de commande** : --doc.other_root_filenames.root_path<br/>**Variable d'environnement** : DOC.OTHER_ROOT_FILENAMES.ROOT_PATH | Ce fichier contient les variables enfants de la famille. | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` | `unique` |
|
||||
| **<a id="doc.other_root_filenames.filename" name="doc.other_root_filenames.filename">doc.other_root_filenames.filename</a>**<br/>**Ligne de commande** : --doc.other_root_filenames.filename<br/>**Variable d'environnement** : DOC.OTHER_ROOT_FILENAMES.FILENAME | Nom du fichier. | [`UNIX filename`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | • le nom de fichier peut être une chemin relatif<br/>• type de fichier autorisé: "file". |
|
||||
|
||||
### Documentation des variables et journal de changements
|
||||
|
||||
> **🛈 Informations**
|
||||
> [!NOTE]
|
||||
>
|
||||
> **Chemin** : doc.tabulars\
|
||||
> *`désactivé`*\
|
||||
> **Désactivé** : si "[Le format de sortie de la documentation générée](#doc.output_format)" en json ou si "[Contenu généré](#doc.contents)" n'est pas variables ou changelog
|
||||
|
||||
| Variable | Description | Valeur par défaut | Type | Contrôle des accès | Validateur |
|
||||
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------|---------------------|---------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------|
|
||||
| **<a id="doc.tabulars.without_family" name="doc.tabulars.without_family">doc.tabulars.without_family</a>**<br/>**Ligne de commande** : <br/>• -df, --doc.tabulars.without_family<br/>• -ndf, --doc.tabulars.no-without_family<br/>**Variable d'environnement** : ROUGAILCLI_DOC.TABULARS.WITHOUT_FAMILY | Ne pas ajouter les familles dans la documentation. | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | | |
|
||||
| **<a id="doc.tabulars.with_commandline" name="doc.tabulars.with_commandline">doc.tabulars.with_commandline</a>**<br/>**Ligne de commande** : <br/>• -dw, --doc.tabulars.with_commandline<br/>• -ndw, --doc.tabulars.no-with_commandline<br/>**Variable d'environnement** : ROUGAILCLI_DOC.TABULARS.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` | | |
|
||||
| **<a id="doc.tabulars.with_environment" name="doc.tabulars.with_environment">doc.tabulars.with_environment</a>**<br/>**Ligne de commande** : <br/>• -de, --doc.tabulars.with_environment<br/>• -nde, --doc.tabulars.no-with_environment<br/>**Variable d'environnement** : ROUGAILCLI_DOC.TABULARS.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` | | |
|
||||
| **<a id="doc.tabulars.environment_prefix" name="doc.tabulars.environment_prefix">doc.tabulars.environment_prefix</a>**<br/>**Ligne de commande** : -dv, --doc.tabulars.environment_prefix<br/>**Variable d'environnement** : ROUGAILCLI_DOC.TABULARS.ENVIRONMENT_PREFIX | Préfixe du nom des variables d'environnement. | ROUGAIL | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | *`désactivé`*<br/>**Désactivé** : si "main_namespace" n'est pas défini ou "[Ajoute les informations de variable d'environnement dans la documentation](#doc.tabulars.with_environment)" est false | Doit seulement utilise des caractères en majuscule. |
|
||||
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------|---------------------|---------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------|
|
||||
| **<a id="doc.tabulars.without_family" name="doc.tabulars.without_family">doc.tabulars.without_family</a>**<br/>**Ligne de commande** : <br/>• -df, --doc.tabulars.without_family<br/>• -ndf, --doc.tabulars.no-without_family<br/>**Variable d'environnement** : DOC.TABULARS.WITHOUT_FAMILY | Ne pas ajouter les familles dans la documentation. | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | | |
|
||||
| **<a id="doc.tabulars.with_commandline" name="doc.tabulars.with_commandline">doc.tabulars.with_commandline</a>**<br/>**Ligne de commande** : <br/>• -dw, --doc.tabulars.with_commandline<br/>• -ndw, --doc.tabulars.no-with_commandline<br/>**Variable d'environnement** : DOC.TABULARS.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` | | |
|
||||
| **<a id="doc.tabulars.with_environment" name="doc.tabulars.with_environment">doc.tabulars.with_environment</a>**<br/>**Ligne de commande** : <br/>• -de, --doc.tabulars.with_environment<br/>• -nde, --doc.tabulars.no-with_environment<br/>**Variable d'environnement** : DOC.TABULARS.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` | | |
|
||||
| **<a id="doc.tabulars.environment_prefix" name="doc.tabulars.environment_prefix">doc.tabulars.environment_prefix</a>**<br/>**Ligne de commande** : -dv, --doc.tabulars.environment_prefix<br/>**Variable d'environnement** : DOC.TABULARS.ENVIRONMENT_PREFIX | Préfixe du nom des variables d'environnement. | ROUGAIL | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | *`désactivé`*<br/>**Désactivé** : si "main_namespace" n'est pas défini ou "[Ajoute les informations de variable d'environnement dans la documentation](#doc.tabulars.with_environment)" est false | Doit seulement utilise des caractères en majuscule. |
|
||||
|
||||
### Documentation du journal des changements
|
||||
|
||||
> **🛈 Informations**
|
||||
> [!NOTE]
|
||||
>
|
||||
> **Chemin** : doc.changelog\
|
||||
> *`désactivé`*\
|
||||
> **Désactivé** : changelog n'est pas défini dans "[Contenu généré](#doc.contents)"
|
||||
|
||||
| Variable | Description | Type |
|
||||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------|
|
||||
| **<a id="doc.changelog.previous_json_file" name="doc.changelog.previous_json_file">doc.changelog.previous_json_file</a>**<br/>**Ligne de commande** : -dp, --doc.changelog.previous_json_file<br/>**Variable d'environnement** : ROUGAILCLI_DOC.CHANGELOG.PREVIOUS_JSON_FILE | Précédent fichier de description au format JSON.<br/>Pour générer le journal des changements, vous devez comparer l'ancienne liste des variables (au format json) avec les variables courantes. | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` |
|
||||
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------|
|
||||
| **<a id="doc.changelog.previous_json_file" name="doc.changelog.previous_json_file">doc.changelog.previous_json_file</a>**<br/>**Ligne de commande** : -dp, --doc.changelog.previous_json_file<br/>**Variable d'environnement** : DOC.CHANGELOG.PREVIOUS_JSON_FILE | Précédent fichier de description au format JSON.<br/>Pour générer le journal des changements, vous devez comparer l'ancienne liste des variables (au format json) avec les variables courantes. | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` |
|
||||
|
||||
### Configuration des exemples
|
||||
|
||||
> **🛈 Informations**
|
||||
> [!NOTE]
|
||||
>
|
||||
> **Chemin** : doc.examples\
|
||||
> *`désactivé`*\
|
||||
> **Désactivé** : si example n'est pas défini dans "[Contenu généré](#doc.contents)"
|
||||
|
||||
| Variable | Description | Valeur par défaut | Type | Contrôle des accès |
|
||||
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------|---------------------|---------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| **<a id="doc.examples.comment" name="doc.examples.comment">doc.examples.comment</a>**<br/>**Ligne de commande** : <br/>• -dx, --doc.examples.comment<br/>• -ndx, --doc.examples.no-comment<br/>**Variable d'environnement** : ROUGAILCLI_DOC.EXAMPLES.COMMENT | 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` | |
|
||||
| **<a id="doc.examples.comment_column" name="doc.examples.comment_column">doc.examples.comment_column</a>**<br/>**Ligne de commande** : --doc.examples.comment_column<br/>**Variable d'environnement** : ROUGAILCLI_DOC.EXAMPLES.COMMENT_COLUMN | Commentaire dans les exemples commence à la colonne. | 30 | [`integer`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | *`désactivé`*<br/>**Désactivé** : lorsque la variable "[Ajouter la description des variables et des familles lorsqu'on génère des exemples](#doc.examples.comment)" a la valeur "false" |
|
||||
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------|---------------------|---------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| **<a id="doc.examples.comment" name="doc.examples.comment">doc.examples.comment</a>**<br/>**Ligne de commande** : <br/>• -dx, --doc.examples.comment<br/>• -ndx, --doc.examples.no-comment<br/>**Variable d'environnement** : DOC.EXAMPLES.COMMENT | 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` | |
|
||||
| **<a id="doc.examples.comment_column" name="doc.examples.comment_column">doc.examples.comment_column</a>**<br/>**Ligne de commande** : --doc.examples.comment_column<br/>**Variable d'environnement** : DOC.EXAMPLES.COMMENT_COLUMN | Commentaire dans les exemples commence à la colonne. | 30 | [`integer`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | *`désactivé`*<br/>**Désactivé** : lorsque la variable "[Ajouter la description des variables et des familles lorsqu'on génère des exemples](#doc.examples.comment)" a la valeur "false" |
|
||||
|
||||
|
||||
|
|
|
|||
52
README.md
52
README.md
|
|
@ -6,7 +6,7 @@ include_toc: true
|
|||
|
||||
## Generate documentation from structural files
|
||||
|
||||
> **🛈 Informations**
|
||||
> [!NOTE]
|
||||
>
|
||||
> The structural files contain all the information related to the variables. This output generates the documentation for all or some of these variables.\
|
||||
> **Path**: doc\
|
||||
|
|
@ -14,18 +14,18 @@ include_toc: true
|
|||
> **Disabled**: if doc is not set in "[Select for output](#step.output)"
|
||||
|
||||
| Variable | Description | Default value | Type | Access control | Validator |
|
||||
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------|-----------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| **<a id="doc.output_format" name="doc.output_format">doc.output_format</a>**<br/>**Command line**: -do, --doc.output_format<br/>**Environment variable**: ROUGAILCLI_DOC.OUTPUT_FORMAT | The output format of the generated documentation. | console | [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | | **Choices**: <br/>• console<br/>• asciidoc<br/>• html<br/>• github<br/>• gitlab<br/>• json |
|
||||
| **<a id="doc.tabular_template" name="doc.tabular_template">doc.tabular_template</a>**<br/>**Command line**: -dm, --doc.tabular_template<br/>**Environment variable**: ROUGAILCLI_DOC.TABULAR_TEMPLATE | Generate document with this tabular model.<br/>The variables are documented with a tabular view. A template selection allows you to choose the content of each column. | two_columns | [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | *`disabled`*<br/>**Disabled**: "[The output format of the generated documentation](#doc.output_format)" in json is not compatible with this variable<br/> | **Choices**: <br/>• two_columns<br/>• three_columns<br/>• four_columns<br/>• five_columns<br/>• six_columns |
|
||||
| **<a id="doc.contents" name="doc.contents">doc.contents</a>**<br/>**Command line**: -dc, --doc.contents<br/>**Environment variable**: ROUGAILCLI_DOC.CONTENTS | Generated content.<br/>You can generate three type of document. All variables ("variables"), an example file in YAML format ("example") or change log ("changelog"). | • variables | [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` `mandatory` | *`hidden`*<br/>**Hidden**: "[The output format of the generated documentation](#doc.output_format)" in json is not compatible with changelog or example "[Generated content](#doc.contents)"<br/> | `unique`<br/>**Choices**: <br/>• variables<br/>• example<br/>• changelog |
|
||||
| **<a id="doc.title_level" name="doc.title_level">doc.title_level</a>**<br/>**Command line**: -dt, --doc.title_level<br/>**Environment variable**: ROUGAILCLI_DOC.TITLE_LEVEL | Starting title level. | 1 | [`integer`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | | |
|
||||
| **<a id="doc.default_values" name="doc.default_values">doc.default_values</a>**<br/>**Command line**: <br/>• --doc.default_values<br/>• --doc.no-default_values<br/>**Environment variable**: ROUGAILCLI_DOC.DEFAULT_VALUES | Modify values to document all variables.<br/>To document leadership or dynamic family variables, it is sometimes necessary to generate values, which can change the values in the configuration. Be careful if you reuse this configuration. | true | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | | |
|
||||
| **<a id="doc.true_color" name="doc.true_color">doc.true_color</a>**<br/>**Command line**: <br/>• --doc.true_color<br/>• --doc.no-true_color<br/>**Environment variable**: ROUGAILCLI_DOC.TRUE_COLOR | Display documentation in console always with true color terminal. | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | *`disabled`*<br/>**Disabled**: when the variable "[The output format of the generated documentation](#doc.output_format)" hasn't the value "console" | |
|
||||
| **<a id="doc.root" name="doc.root">doc.root</a>**<br/>**Command line**: -dr, --doc.root<br/>**Environment variable**: ROUGAILCLI_DOC.ROOT | Document the child variables of the family.<br/>By default, all accessible variables are included in the documentation. It is possible to define the family from which the documentation should be generated. | | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) | | |
|
||||
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------|-----------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| **<a id="doc.output_format" name="doc.output_format">doc.output_format</a>**<br/>**Command line**: -do, --doc.output_format<br/>**Environment variable**: DOC.OUTPUT_FORMAT | The output format of the generated documentation. | console | [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | | **Choices**: <br/>• console<br/>• asciidoc<br/>• html<br/>• github<br/>• gitlab<br/>• json |
|
||||
| **<a id="doc.tabular_template" name="doc.tabular_template">doc.tabular_template</a>**<br/>**Command line**: -dm, --doc.tabular_template<br/>**Environment variable**: DOC.TABULAR_TEMPLATE | Generate document with this tabular model.<br/>The variables are documented with a tabular view. A template selection allows you to choose the content of each column. | two_columns | [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | *`disabled`*<br/>**Disabled**: "[The output format of the generated documentation](#doc.output_format)" in json is not compatible with this variable<br/> | **Choices**: <br/>• two_columns<br/>• three_columns<br/>• four_columns<br/>• five_columns<br/>• six_columns |
|
||||
| **<a id="doc.contents" name="doc.contents">doc.contents</a>**<br/>**Command line**: -dc, --doc.contents<br/>**Environment variable**: DOC.CONTENTS | Generated content.<br/>You can generate three type of document. All variables ("variables"), an example file in YAML format ("example") or change log ("changelog"). | • variables | [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` `mandatory` | *`hidden`*<br/>**Hidden**: "[The output format of the generated documentation](#doc.output_format)" in json is not compatible with changelog or example "[Generated content](#doc.contents)"<br/> | `unique`<br/>**Choices**: <br/>• variables<br/>• example<br/>• changelog |
|
||||
| **<a id="doc.title_level" name="doc.title_level">doc.title_level</a>**<br/>**Command line**: -dt, --doc.title_level<br/>**Environment variable**: DOC.TITLE_LEVEL | Starting title level. | 1 | [`integer`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | | |
|
||||
| **<a id="doc.default_values" name="doc.default_values">doc.default_values</a>**<br/>**Command line**: <br/>• --doc.default_values<br/>• --doc.no-default_values<br/>**Environment variable**: DOC.DEFAULT_VALUES | Modify values to document all variables.<br/>To document leadership or dynamic family variables, it is sometimes necessary to generate values, which can change the values in the configuration. Be careful if you reuse this configuration. | true | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | | |
|
||||
| **<a id="doc.true_color" name="doc.true_color">doc.true_color</a>**<br/>**Command line**: <br/>• --doc.true_color<br/>• --doc.no-true_color<br/>**Environment variable**: DOC.TRUE_COLOR | Display documentation in console always with true color terminal. | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | *`disabled`*<br/>**Disabled**: when the variable "[The output format of the generated documentation](#doc.output_format)" hasn't the value "console" | |
|
||||
| **<a id="doc.root" name="doc.root">doc.root</a>**<br/>**Command line**: -dr, --doc.root<br/>**Environment variable**: DOC.ROOT | Document the child variables of the family.<br/>By default, all accessible variables are included in the documentation. It is possible to define the family from which the documentation should be generated. | | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) | | |
|
||||
|
||||
### The variables in this family are documented in another file
|
||||
|
||||
> **🛈 Informations**
|
||||
> [!NOTE]
|
||||
>
|
||||
> If you separate the variables into different files, the links between the variables will break. Therefore, you must define different filenames for the files containing these variables.\
|
||||
> This family contains lists of variable blocks.\
|
||||
|
|
@ -34,48 +34,48 @@ include_toc: true
|
|||
> **Disabled**: when the variable "[Document the child variables of the family](#doc.root)" has the value "null"
|
||||
|
||||
| Variable | Description | Type | Validator |
|
||||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------|-------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------|
|
||||
| **<a id="doc.other_root_filenames.root_path" name="doc.other_root_filenames.root_path">doc.other_root_filenames.root_path</a>**<br/>**Command line**: --doc.other_root_filenames.root_path<br/>**Environment variable**: ROUGAILCLI_DOC.OTHER_ROOT_FILENAMES.ROOT_PATH | This file contains child variables of the family. | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` | `unique` |
|
||||
| **<a id="doc.other_root_filenames.filename" name="doc.other_root_filenames.filename">doc.other_root_filenames.filename</a>**<br/>**Command line**: --doc.other_root_filenames.filename<br/>**Environment variable**: ROUGAILCLI_DOC.OTHER_ROOT_FILENAMES.FILENAME | Name of the file. | [`UNIX filename`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | • this filename could be a relative path<br/>• file type allowed: "file". |
|
||||
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------|-------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------|
|
||||
| **<a id="doc.other_root_filenames.root_path" name="doc.other_root_filenames.root_path">doc.other_root_filenames.root_path</a>**<br/>**Command line**: --doc.other_root_filenames.root_path<br/>**Environment variable**: DOC.OTHER_ROOT_FILENAMES.ROOT_PATH | This file contains child variables of the family. | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` | `unique` |
|
||||
| **<a id="doc.other_root_filenames.filename" name="doc.other_root_filenames.filename">doc.other_root_filenames.filename</a>**<br/>**Command line**: --doc.other_root_filenames.filename<br/>**Environment variable**: DOC.OTHER_ROOT_FILENAMES.FILENAME | Name of the file. | [`UNIX filename`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | • this filename could be a relative path<br/>• file type allowed: "file". |
|
||||
|
||||
### Variables and changelog documentation
|
||||
|
||||
> **🛈 Informations**
|
||||
> [!NOTE]
|
||||
>
|
||||
> **Path**: doc.tabulars\
|
||||
> *`disabled`*\
|
||||
> **Disabled**: if "[The output format of the generated documentation](#doc.output_format)" is json or "[Generated content](#doc.contents)" hasn't variables or changelog
|
||||
|
||||
| Variable | Description | Default value | Type | Access control | Validator |
|
||||
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------|-----------------|-------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------|
|
||||
| **<a id="doc.tabulars.without_family" name="doc.tabulars.without_family">doc.tabulars.without_family</a>**<br/>**Command line**: <br/>• -df, --doc.tabulars.without_family<br/>• -ndf, --doc.tabulars.no-without_family<br/>**Environment variable**: ROUGAILCLI_DOC.TABULARS.WITHOUT_FAMILY | Do not add families in documentation. | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | | |
|
||||
| **<a id="doc.tabulars.with_commandline" name="doc.tabulars.with_commandline">doc.tabulars.with_commandline</a>**<br/>**Command line**: <br/>• -dw, --doc.tabulars.with_commandline<br/>• -ndw, --doc.tabulars.no-with_commandline<br/>**Environment variable**: ROUGAILCLI_DOC.TABULARS.WITH_COMMANDLINE | Add command line informations in documentation. | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | | |
|
||||
| **<a id="doc.tabulars.with_environment" name="doc.tabulars.with_environment">doc.tabulars.with_environment</a>**<br/>**Command line**: <br/>• -de, --doc.tabulars.with_environment<br/>• -nde, --doc.tabulars.no-with_environment<br/>**Environment variable**: ROUGAILCLI_DOC.TABULARS.WITH_ENVIRONMENT | Add environment variable informations in documentation. | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | | |
|
||||
| **<a id="doc.tabulars.environment_prefix" name="doc.tabulars.environment_prefix">doc.tabulars.environment_prefix</a>**<br/>**Command line**: -dv, --doc.tabulars.environment_prefix<br/>**Environment variable**: ROUGAILCLI_DOC.TABULARS.ENVIRONMENT_PREFIX | Environment variables prefix name. | ROUGAIL | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | *`disabled`*<br/>**Disabled**: if "main_namespace" is not set or "[Add environment variable informations in documentation](#doc.tabulars.with_environment)" is false | Should only use uppercase characters. |
|
||||
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------|-----------------|-------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------|
|
||||
| **<a id="doc.tabulars.without_family" name="doc.tabulars.without_family">doc.tabulars.without_family</a>**<br/>**Command line**: <br/>• -df, --doc.tabulars.without_family<br/>• -ndf, --doc.tabulars.no-without_family<br/>**Environment variable**: DOC.TABULARS.WITHOUT_FAMILY | Do not add families in documentation. | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | | |
|
||||
| **<a id="doc.tabulars.with_commandline" name="doc.tabulars.with_commandline">doc.tabulars.with_commandline</a>**<br/>**Command line**: <br/>• -dw, --doc.tabulars.with_commandline<br/>• -ndw, --doc.tabulars.no-with_commandline<br/>**Environment variable**: DOC.TABULARS.WITH_COMMANDLINE | Add command line informations in documentation. | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | | |
|
||||
| **<a id="doc.tabulars.with_environment" name="doc.tabulars.with_environment">doc.tabulars.with_environment</a>**<br/>**Command line**: <br/>• -de, --doc.tabulars.with_environment<br/>• -nde, --doc.tabulars.no-with_environment<br/>**Environment variable**: DOC.TABULARS.WITH_ENVIRONMENT | Add environment variable informations in documentation. | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | | |
|
||||
| **<a id="doc.tabulars.environment_prefix" name="doc.tabulars.environment_prefix">doc.tabulars.environment_prefix</a>**<br/>**Command line**: -dv, --doc.tabulars.environment_prefix<br/>**Environment variable**: DOC.TABULARS.ENVIRONMENT_PREFIX | Environment variables prefix name. | ROUGAIL | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | *`disabled`*<br/>**Disabled**: if "main_namespace" is not set or "[Add environment variable informations in documentation](#doc.tabulars.with_environment)" is false | Should only use uppercase characters. |
|
||||
|
||||
### Changelog documentation
|
||||
|
||||
> **🛈 Informations**
|
||||
> [!NOTE]
|
||||
>
|
||||
> **Path**: doc.changelog\
|
||||
> *`disabled`*\
|
||||
> **Disabled**: if changelog in not in "[Generated content](#doc.contents)"
|
||||
|
||||
| Variable | Description | Type |
|
||||
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------|
|
||||
| **<a id="doc.changelog.previous_json_file" name="doc.changelog.previous_json_file">doc.changelog.previous_json_file</a>**<br/>**Command line**: -dp, --doc.changelog.previous_json_file<br/>**Environment variable**: ROUGAILCLI_DOC.CHANGELOG.PREVIOUS_JSON_FILE | Previous description file in JSON format.<br/>To generate the changelog, you need to compare the old list of variables (in json format) with the current variables. | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` |
|
||||
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------|
|
||||
| **<a id="doc.changelog.previous_json_file" name="doc.changelog.previous_json_file">doc.changelog.previous_json_file</a>**<br/>**Command line**: -dp, --doc.changelog.previous_json_file<br/>**Environment variable**: DOC.CHANGELOG.PREVIOUS_JSON_FILE | Previous description file in JSON format.<br/>To generate the changelog, you need to compare the old list of variables (in json format) with the current variables. | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` |
|
||||
|
||||
### Examples configuration
|
||||
|
||||
> **🛈 Informations**
|
||||
> [!NOTE]
|
||||
>
|
||||
> **Path**: doc.examples\
|
||||
> *`disabled`*\
|
||||
> **Disabled**: if example is not in "[Generated content](#doc.contents)"
|
||||
|
||||
| Variable | Description | Default value | Type | Access control |
|
||||
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------|-----------------|-------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| **<a id="doc.examples.comment" name="doc.examples.comment">doc.examples.comment</a>**<br/>**Command line**: <br/>• -dx, --doc.examples.comment<br/>• -ndx, --doc.examples.no-comment<br/>**Environment variable**: ROUGAILCLI_DOC.EXAMPLES.COMMENT | Add description of variables and families when generate examples. | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | |
|
||||
| **<a id="doc.examples.comment_column" name="doc.examples.comment_column">doc.examples.comment_column</a>**<br/>**Command line**: --doc.examples.comment_column<br/>**Environment variable**: ROUGAILCLI_DOC.EXAMPLES.COMMENT_COLUMN | Comment in examples starts at column. | 30 | [`integer`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | *`disabled`*<br/>**Disabled**: when the variable "[Add description of variables and families when generate examples](#doc.examples.comment)" has the value "false" |
|
||||
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------|-----------------|-------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| **<a id="doc.examples.comment" name="doc.examples.comment">doc.examples.comment</a>**<br/>**Command line**: <br/>• -dx, --doc.examples.comment<br/>• -ndx, --doc.examples.no-comment<br/>**Environment variable**: DOC.EXAMPLES.COMMENT | Add description of variables and families when generate examples. | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | |
|
||||
| **<a id="doc.examples.comment_column" name="doc.examples.comment_column">doc.examples.comment_column</a>**<br/>**Command line**: --doc.examples.comment_column<br/>**Environment variable**: DOC.EXAMPLES.COMMENT_COLUMN | Comment in examples starts at column. | 30 | [`integer`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | *`disabled`*<br/>**Disabled**: when the variable "[Add description of variables and families when generate examples](#doc.examples.comment)" has the value "false" |
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -5,8 +5,8 @@
|
|||
msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: \n"
|
||||
"POT-Creation-Date: 2025-12-02 12:49+0100\n"
|
||||
"PO-Revision-Date: 2025-12-02 12:53+0100\n"
|
||||
"POT-Creation-Date: 2025-12-22 08:53+0100\n"
|
||||
"PO-Revision-Date: 2025-12-22 08:54+0100\n"
|
||||
"Last-Translator: \n"
|
||||
"Language-Team: \n"
|
||||
"Language: fr\n"
|
||||
|
|
@ -64,11 +64,15 @@ msgstr "niveau dupliqué pour rougail-doc pour {0} \"{1}\": {2} et {3}"
|
|||
msgid "duplicated name \"{0}\" in rougail-output-doc"
|
||||
msgstr "nom dupliqué \"{0}\" dans rougail-output-doc"
|
||||
|
||||
#: src/rougail/output_doc/config.py:123
|
||||
#: src/rougail/output_doc/config.py:117
|
||||
msgid "is true if doc is activate"
|
||||
msgstr "est true si doc est activé"
|
||||
|
||||
#: src/rougail/output_doc/config.py:120
|
||||
msgid "Generate documentation from structural files"
|
||||
msgstr "Générer la documentation depuis les fichiers de structure"
|
||||
|
||||
#: src/rougail/output_doc/config.py:124
|
||||
#: src/rougail/output_doc/config.py:121
|
||||
msgid ""
|
||||
"The structural files contain all the information related to the variables. "
|
||||
"This output generates the documentation for all or some of these variables."
|
||||
|
|
@ -77,19 +81,19 @@ msgstr ""
|
|||
"variables. Cette sortie génère la documentation pour tout ou partie de ces "
|
||||
"variables."
|
||||
|
||||
#: src/rougail/output_doc/config.py:133
|
||||
#: src/rougail/output_doc/config.py:126
|
||||
msgid "if doc is not set in \"step.output\""
|
||||
msgstr "si doc n'est pas spécifié dans \"step.output\""
|
||||
|
||||
#: src/rougail/output_doc/config.py:136
|
||||
#: src/rougail/output_doc/config.py:129
|
||||
msgid "The output format of the generated documentation"
|
||||
msgstr "Le format de sortie de la documentation générée"
|
||||
|
||||
#: src/rougail/output_doc/config.py:145
|
||||
#: src/rougail/output_doc/config.py:138
|
||||
msgid "Generate document with this tabular model"
|
||||
msgstr "Génère la documentation avec ce modèle de tableau"
|
||||
|
||||
#: src/rougail/output_doc/config.py:146
|
||||
#: src/rougail/output_doc/config.py:139
|
||||
msgid ""
|
||||
"The variables are documented with a tabular view. A template selection "
|
||||
"allows you to choose the content of each column."
|
||||
|
|
@ -97,15 +101,15 @@ msgstr ""
|
|||
"Les variables sont documentées avec une vue tableau. Une sélection de modèle "
|
||||
"vous permet de choisir le contenu de chaque colonne."
|
||||
|
||||
#: src/rougail/output_doc/config.py:153
|
||||
#: src/rougail/output_doc/config.py:147
|
||||
msgid "\"_.output_format\" in json is not compatible with this variable"
|
||||
msgstr "\"_.output_format\" en json n\\'est pas compatible avec cette variable"
|
||||
|
||||
#: src/rougail/output_doc/config.py:160
|
||||
#: src/rougail/output_doc/config.py:154
|
||||
msgid "Generated content"
|
||||
msgstr "Contenu généré"
|
||||
|
||||
#: src/rougail/output_doc/config.py:161
|
||||
#: src/rougail/output_doc/config.py:155
|
||||
msgid ""
|
||||
"You can generate three type of document. All variables (\"variables\"), an "
|
||||
"example file in YAML format (\"example\") or change log (\"changelog\")."
|
||||
|
|
@ -114,7 +118,7 @@ msgstr ""
|
|||
"(\"variables\"), un exemple de fichier au format YAML (\"example\") ou le "
|
||||
"journal des changements (\"changelog\")."
|
||||
|
||||
#: src/rougail/output_doc/config.py:173
|
||||
#: src/rougail/output_doc/config.py:168
|
||||
msgid ""
|
||||
"\"_.output_format\" in json is not compatible with changelog or example "
|
||||
"\"_.contents\""
|
||||
|
|
@ -122,15 +126,15 @@ msgstr ""
|
|||
"\"_.output_format\" en json n'est pas compatible avec \"_.contents\" "
|
||||
"changelog or example"
|
||||
|
||||
#: src/rougail/output_doc/config.py:176
|
||||
#: src/rougail/output_doc/config.py:171
|
||||
msgid "Starting title level"
|
||||
msgstr "Niveau de titre de départ"
|
||||
|
||||
#: src/rougail/output_doc/config.py:181
|
||||
#: src/rougail/output_doc/config.py:176
|
||||
msgid "Modify values to document all variables"
|
||||
msgstr "Modifier les valeurs pour documenter toutes les variables"
|
||||
|
||||
#: src/rougail/output_doc/config.py:182
|
||||
#: src/rougail/output_doc/config.py:177
|
||||
msgid ""
|
||||
"To document leadership or dynamic family variables, it is sometimes "
|
||||
"necessary to generate values, which can change the values in the "
|
||||
|
|
@ -141,17 +145,17 @@ msgstr ""
|
|||
"valeurs de la configuration. Soyez vigilent si vous réutilisez cette "
|
||||
"configuration."
|
||||
|
||||
#: src/rougail/output_doc/config.py:186
|
||||
#: src/rougail/output_doc/config.py:181
|
||||
msgid "Display documentation in console always with true color terminal"
|
||||
msgstr ""
|
||||
"Afficher la documentation dans la console en permanence avec un terminal en "
|
||||
"couleurs réelles"
|
||||
|
||||
#: src/rougail/output_doc/config.py:193
|
||||
#: src/rougail/output_doc/config.py:188
|
||||
msgid "Document the child variables of the family"
|
||||
msgstr "Documenter les variables enfants de cette famille"
|
||||
|
||||
#: src/rougail/output_doc/config.py:194
|
||||
#: src/rougail/output_doc/config.py:189
|
||||
msgid ""
|
||||
"By default, all accessible variables are included in the documentation. It "
|
||||
"is possible to define the family from which the documentation should be "
|
||||
|
|
@ -161,11 +165,11 @@ msgstr ""
|
|||
"documentation. Il est possible de définir une famille a partir de laquelle "
|
||||
"la documentation doit être générée."
|
||||
|
||||
#: src/rougail/output_doc/config.py:199
|
||||
#: src/rougail/output_doc/config.py:194
|
||||
msgid "The variables in this family are documented in another file"
|
||||
msgstr "Les variables pour cette famille sont documentés dans un autre fichier"
|
||||
|
||||
#: src/rougail/output_doc/config.py:200
|
||||
#: src/rougail/output_doc/config.py:195
|
||||
msgid ""
|
||||
"If you separate the variables into different files, the links between the "
|
||||
"variables will break. Therefore, you must define different filenames for the "
|
||||
|
|
@ -175,19 +179,19 @@ msgstr ""
|
|||
"variables va être cassé. Dans ce cas, vous devez définit différents nom de "
|
||||
"fichiers pour les fichiers contenant ces variables."
|
||||
|
||||
#: src/rougail/output_doc/config.py:207
|
||||
#: src/rougail/output_doc/config.py:202
|
||||
msgid "This file contains child variables of the family"
|
||||
msgstr "Ce fichier contient les variables enfants de la famille"
|
||||
|
||||
#: src/rougail/output_doc/config.py:211
|
||||
#: src/rougail/output_doc/config.py:206
|
||||
msgid "Name of the file"
|
||||
msgstr "Nom du fichier"
|
||||
|
||||
#: src/rougail/output_doc/config.py:219
|
||||
#: src/rougail/output_doc/config.py:214
|
||||
msgid "Variables and changelog documentation"
|
||||
msgstr "Documentation des variables et journal de changements"
|
||||
|
||||
#: src/rougail/output_doc/config.py:224
|
||||
#: src/rougail/output_doc/config.py:219
|
||||
msgid ""
|
||||
"if \"_.output_format\" is json or \"_.contents\" hasn't variables or "
|
||||
"changelog"
|
||||
|
|
@ -195,45 +199,45 @@ msgstr ""
|
|||
"si \"_.output_format\" en json ou si \"_.contents\" n'est pas variables ou "
|
||||
"changelog"
|
||||
|
||||
#: src/rougail/output_doc/config.py:227
|
||||
#: src/rougail/output_doc/config.py:222
|
||||
msgid "Do not add families in documentation"
|
||||
msgstr "Ne pas ajouter les familles dans la documentation"
|
||||
|
||||
#: src/rougail/output_doc/config.py:232
|
||||
#: src/rougail/output_doc/config.py:227
|
||||
msgid "Add command line informations in documentation"
|
||||
msgstr "Ajoute les informations de la ligne de commande dans la documentation"
|
||||
|
||||
#: src/rougail/output_doc/config.py:237
|
||||
#: src/rougail/output_doc/config.py:232
|
||||
msgid "Add environment variable informations in documentation"
|
||||
msgstr ""
|
||||
"Ajoute les informations de variable d'environnement dans la documentation"
|
||||
|
||||
#: src/rougail/output_doc/config.py:242
|
||||
#: src/rougail/output_doc/config.py:237
|
||||
msgid "Environment variables prefix name"
|
||||
msgstr "Préfixe du nom des variables d'environnement"
|
||||
|
||||
#: src/rougail/output_doc/config.py:249
|
||||
#: src/rougail/output_doc/config.py:244
|
||||
msgid "should only use uppercase characters"
|
||||
msgstr "doit seulement utilise des caractères en majuscule"
|
||||
|
||||
#: src/rougail/output_doc/config.py:254
|
||||
#: src/rougail/output_doc/config.py:249
|
||||
msgid "if \"main_namespace\" is not set or \"_.with_environment\" is false"
|
||||
msgstr ""
|
||||
"si \"main_namespace\" n'est pas défini ou \"_.with_environment\" est false"
|
||||
|
||||
#: src/rougail/output_doc/config.py:257
|
||||
#: src/rougail/output_doc/config.py:252
|
||||
msgid "Changelog documentation"
|
||||
msgstr "Documentation du journal des changements"
|
||||
|
||||
#: src/rougail/output_doc/config.py:262
|
||||
#: src/rougail/output_doc/config.py:257
|
||||
msgid "if changelog in not in \"_.contents\""
|
||||
msgstr "changelog n'est pas défini dans \"_.contents\""
|
||||
|
||||
#: src/rougail/output_doc/config.py:265
|
||||
#: src/rougail/output_doc/config.py:260
|
||||
msgid "Previous description file in JSON format"
|
||||
msgstr "Précédent fichier de description au format JSON"
|
||||
|
||||
#: src/rougail/output_doc/config.py:266
|
||||
#: src/rougail/output_doc/config.py:261
|
||||
msgid ""
|
||||
"To generate the changelog, you need to compare the old list of variables (in "
|
||||
"json format) with the current variables."
|
||||
|
|
@ -241,21 +245,21 @@ msgstr ""
|
|||
"Pour générer le journal des changements, vous devez comparer l'ancienne "
|
||||
"liste des variables (au format json) avec les variables courantes."
|
||||
|
||||
#: src/rougail/output_doc/config.py:270
|
||||
#: src/rougail/output_doc/config.py:265
|
||||
msgid "Examples configuration"
|
||||
msgstr "Configuration des exemples"
|
||||
|
||||
#: src/rougail/output_doc/config.py:275
|
||||
#: src/rougail/output_doc/config.py:270
|
||||
msgid "if example is not in \"_.contents\""
|
||||
msgstr "si example n'est pas défini dans \"_.contents\""
|
||||
|
||||
#: src/rougail/output_doc/config.py:278
|
||||
#: src/rougail/output_doc/config.py:273
|
||||
msgid "Add description of variables and families when generate examples"
|
||||
msgstr ""
|
||||
"Ajouter la description des variables et des familles lorsqu'on génère des "
|
||||
"exemples"
|
||||
|
||||
#: src/rougail/output_doc/config.py:283
|
||||
#: src/rougail/output_doc/config.py:278
|
||||
msgid "Comment in examples starts at column"
|
||||
msgstr "Commentaire dans les exemples commence à la colonne"
|
||||
|
||||
|
|
@ -402,7 +406,6 @@ msgstr "Exemple avec toutes les variables modifiable"
|
|||
|
||||
#: src/rougail/output_doc/output/asciidoc.py:156
|
||||
#: src/rougail/output_doc/output/console.py:199
|
||||
#: src/rougail/output_doc/output/github.py:196
|
||||
#: src/rougail/output_doc/output/gitlab.py:44
|
||||
msgid "Informations"
|
||||
msgstr "Informations"
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@
|
|||
msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: PACKAGE VERSION\n"
|
||||
"POT-Creation-Date: 2025-12-02 12:54+0100\n"
|
||||
"POT-Creation-Date: 2025-12-22 08:54+0100\n"
|
||||
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
|
||||
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
|
||||
"Language-Team: LANGUAGE <LL@li.org>\n"
|
||||
|
|
@ -63,147 +63,151 @@ msgstr ""
|
|||
msgid "duplicated name \"{0}\" in rougail-output-doc"
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/config.py:123
|
||||
#: src/rougail/output_doc/config.py:117
|
||||
msgid "is true if doc is activate"
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/config.py:120
|
||||
msgid "Generate documentation from structural files"
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/config.py:124
|
||||
#: src/rougail/output_doc/config.py:121
|
||||
msgid "The structural files contain all the information related to the variables. This output generates the documentation for all or some of these variables."
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/config.py:133
|
||||
#: src/rougail/output_doc/config.py:126
|
||||
msgid "if doc is not set in \"step.output\""
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/config.py:136
|
||||
#: src/rougail/output_doc/config.py:129
|
||||
msgid "The output format of the generated documentation"
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/config.py:145
|
||||
#: src/rougail/output_doc/config.py:138
|
||||
msgid "Generate document with this tabular model"
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/config.py:146
|
||||
#: src/rougail/output_doc/config.py:139
|
||||
msgid "The variables are documented with a tabular view. A template selection allows you to choose the content of each column."
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/config.py:153
|
||||
#: src/rougail/output_doc/config.py:147
|
||||
msgid "\"_.output_format\" in json is not compatible with this variable"
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/config.py:160
|
||||
#: src/rougail/output_doc/config.py:154
|
||||
msgid "Generated content"
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/config.py:161
|
||||
#: src/rougail/output_doc/config.py:155
|
||||
msgid "You can generate three type of document. All variables (\"variables\"), an example file in YAML format (\"example\") or change log (\"changelog\")."
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/config.py:173
|
||||
#: src/rougail/output_doc/config.py:168
|
||||
msgid "\"_.output_format\" in json is not compatible with changelog or example \"_.contents\""
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/config.py:176
|
||||
#: src/rougail/output_doc/config.py:171
|
||||
msgid "Starting title level"
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/config.py:181
|
||||
#: src/rougail/output_doc/config.py:176
|
||||
msgid "Modify values to document all variables"
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/config.py:182
|
||||
#: src/rougail/output_doc/config.py:177
|
||||
msgid "To document leadership or dynamic family variables, it is sometimes necessary to generate values, which can change the values in the configuration. Be careful if you reuse this configuration."
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/config.py:186
|
||||
#: src/rougail/output_doc/config.py:181
|
||||
msgid "Display documentation in console always with true color terminal"
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/config.py:193
|
||||
#: src/rougail/output_doc/config.py:188
|
||||
msgid "Document the child variables of the family"
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/config.py:194
|
||||
#: src/rougail/output_doc/config.py:189
|
||||
msgid "By default, all accessible variables are included in the documentation. It is possible to define the family from which the documentation should be generated."
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/config.py:199
|
||||
#: src/rougail/output_doc/config.py:194
|
||||
msgid "The variables in this family are documented in another file"
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/config.py:200
|
||||
#: src/rougail/output_doc/config.py:195
|
||||
msgid "If you separate the variables into different files, the links between the variables will break. Therefore, you must define different filenames for the files containing these variables."
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/config.py:207
|
||||
#: src/rougail/output_doc/config.py:202
|
||||
msgid "This file contains child variables of the family"
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/config.py:211
|
||||
#: src/rougail/output_doc/config.py:206
|
||||
msgid "Name of the file"
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/config.py:219
|
||||
#: src/rougail/output_doc/config.py:214
|
||||
msgid "Variables and changelog documentation"
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/config.py:224
|
||||
#: src/rougail/output_doc/config.py:219
|
||||
msgid "if \"_.output_format\" is json or \"_.contents\" hasn't variables or changelog"
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/config.py:227
|
||||
#: src/rougail/output_doc/config.py:222
|
||||
msgid "Do not add families in documentation"
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/config.py:232
|
||||
#: src/rougail/output_doc/config.py:227
|
||||
msgid "Add command line informations in documentation"
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/config.py:237
|
||||
#: src/rougail/output_doc/config.py:232
|
||||
msgid "Add environment variable informations in documentation"
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/config.py:242
|
||||
#: src/rougail/output_doc/config.py:237
|
||||
msgid "Environment variables prefix name"
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/config.py:249
|
||||
#: src/rougail/output_doc/config.py:244
|
||||
msgid "should only use uppercase characters"
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/config.py:254
|
||||
#: src/rougail/output_doc/config.py:249
|
||||
msgid "if \"main_namespace\" is not set or \"_.with_environment\" is false"
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/config.py:257
|
||||
#: src/rougail/output_doc/config.py:252
|
||||
msgid "Changelog documentation"
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/config.py:262
|
||||
#: src/rougail/output_doc/config.py:257
|
||||
msgid "if changelog in not in \"_.contents\""
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/config.py:265
|
||||
#: src/rougail/output_doc/config.py:260
|
||||
msgid "Previous description file in JSON format"
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/config.py:266
|
||||
#: src/rougail/output_doc/config.py:261
|
||||
msgid "To generate the changelog, you need to compare the old list of variables (in json format) with the current variables."
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/config.py:270
|
||||
#: src/rougail/output_doc/config.py:265
|
||||
msgid "Examples configuration"
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/config.py:275
|
||||
#: src/rougail/output_doc/config.py:270
|
||||
msgid "if example is not in \"_.contents\""
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/config.py:278
|
||||
#: src/rougail/output_doc/config.py:273
|
||||
msgid "Add description of variables and families when generate examples"
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/config.py:283
|
||||
#: src/rougail/output_doc/config.py:278
|
||||
msgid "Comment in examples starts at column"
|
||||
msgstr ""
|
||||
|
||||
|
|
@ -342,7 +346,6 @@ msgstr ""
|
|||
|
||||
#: src/rougail/output_doc/output/asciidoc.py:156
|
||||
#: src/rougail/output_doc/output/console.py:199
|
||||
#: src/rougail/output_doc/output/github.py:196
|
||||
#: src/rougail/output_doc/output/gitlab.py:44
|
||||
msgid "Informations"
|
||||
msgstr ""
|
||||
|
|
|
|||
|
|
@ -113,22 +113,15 @@ cli:
|
|||
exists: true
|
||||
default:
|
||||
jinja: |-
|
||||
{{% if __.step.output is not propertyerror and "doc" in __.step.output %}}
|
||||
true
|
||||
{{% else %}}
|
||||
false
|
||||
{{% endif %}}
|
||||
{{{{ __.step.output is not propertyerror and "doc" in __.step.output }}}}
|
||||
description: {_('is true if doc is activate')}
|
||||
|
||||
doc:
|
||||
description: {_('Generate documentation from structural files')}
|
||||
help: {_('The structural files contain all the information related to the variables. This output generates the documentation for all or some of these variables.')}
|
||||
disabled:
|
||||
jinja: |-
|
||||
{{% if step.output is propertyerror or step.output != 'doc' %}}
|
||||
true
|
||||
{{% else %}}
|
||||
false
|
||||
{{% endif %}}
|
||||
{{{{ step.output is propertyerror or step.output != 'doc' }}}}
|
||||
return_type: boolean
|
||||
description: {_('if doc is not set in "step.output"')}
|
||||
|
||||
|
|
|
|||
Binary file not shown.
|
|
@ -193,9 +193,8 @@ class Formatter(CommonFormatter):
|
|||
return escape(text)
|
||||
|
||||
def family_informations(self) -> str:
|
||||
info = self.bold(f"🛈 {_('Informations')}") # ℹ️
|
||||
starts_line = self.family_informations_starts_line()
|
||||
return starts_line + info + "\n" + starts_line + "\n"
|
||||
return starts_line + "[!NOTE]" + "\n" + starts_line + "\n"
|
||||
|
||||
def family_informations_starts_line(self) -> str:
|
||||
return "> "
|
||||
|
|
|
|||
|
|
@ -66,7 +66,7 @@ def _test_structural_files(test_dir, namespace):
|
|||
rougailconfig = get_rougail_config(test_dir, namespace, relative_to=HERE)
|
||||
if not rougailconfig:
|
||||
return
|
||||
rougailconfig['tiramisu_cache'] = 'p.py'
|
||||
# rougailconfig['tiramisu_cache'] = 'p.py'
|
||||
##################################
|
||||
rougailconfig['step.output'] = 'doc'
|
||||
doc = None
|
||||
|
|
|
|||
Loading…
Reference in a new issue