No description

Find a file

Emmanuel Garette ea5c4ecef6 feat: personalise column number		2025-12-01 11:07:11 +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-12-01 11:07:11 +01:00
tests	feat: personalise column number	2025-12-01 11:07:11 +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-12-01 11:07:11 +01:00

README.md

Table of Contents

Two columns

Generate documentation

The variables in this family are documented in another file
Variable and changelog documentation
Changelog documentation
Examples configuration

Three columns

Generate documentation

The variables in this family are documented in another file
Variable and changelog documentation
Changelog documentation
Examples configuration

Four columns

Generate documentation

The variables in this family are documented in another file
Variable and changelog documentation
Changelog documentation
Examples configuration

Five columns

Generate documentation

The variables in this family are documented in another file
Variable and changelog documentation
Changelog documentation
Examples configuration

Six columns

Generate documentation

The variables in this family are documented in another file
Variable and changelog documentation
Changelog documentation
Examples configuration

Two columns

Generate documentation

🛈 Informations

doc
disabled
Disabled: if doc is not set in "Select for output"

Variable	Description
doc.contents `choice` `multiple` `mandatory` `unique` Command line: -dc, --doc.contents Environment variable: ROUGAILCLI_DOC.CONTENTS	Generated content. You can generate three type of document. All variables ("variables"), an example file in YAML format ("example") or change log ("changelog"). Choices: • variables ← (default) • example • changelog
doc.output_format `choice` `mandatory` Command line: -do, --doc.output_format Environment variable: ROUGAILCLI_DOC.OUTPUT_FORMAT	Generate document in format. Validator: the value json is not compatible with changelog and example "Generated content" Choices: • console ← (default) • asciidoc • html • github • gitlab • json
doc.table_model `choice` `mandatory` Command line: -dm, --doc.table_model Environment variable: ROUGAILCLI_DOC.TABLE_MODEL	Generate document with this table model. Validator: the value json is not compatible with changelog and example "Generated content" Choices: • two_columns ← (default) • three_columns • four_columns • five_columns • six_columns
doc.title_level `integer` `mandatory` Command line: -dt, --doc.title_level Environment variable: ROUGAILCLI_DOC.TITLE_LEVEL	Starting title level. Default: 1
doc.default_values `boolean` `mandatory` Command line: • --doc.default_values • --doc.no-default_values Environment variable: ROUGAILCLI_DOC.DEFAULT_VALUES	Modify values to document all variables. 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. Default: true
doc.true_color `boolean` `mandatory` `disabled` Command line: • --doc.true_color • --doc.no-true_color Environment variable: ROUGAILCLI_DOC.TRUE_COLOR	Display documentation in console always with true color terminal. Default: false Disabled: when the variable "Generate document in format" hasn't the value "console"
doc.root `string` Command line: -dr, --doc.root Environment variable: ROUGAILCLI_DOC.ROOT	Document the child variables of the family.

The variables in this family are documented in another file

🛈 Informations

doc.other_root_filenames
This family contains lists of variable blocks.
disabled
Disabled: if "Document the child variables of the family" haven't any value

Variable	Description
doc.other_root_filenames.root_path `string` `multiple` `unique` Command line: --doc.other_root_filenames.root_path Environment variable: ROUGAILCLI_DOC.OTHER_ROOT_FILENAMES.ROOT_PATH	Family name.
doc.other_root_filenames.filename `UNIX filename` `mandatory` Command line: --doc.other_root_filenames.filename Environment variable: ROUGAILCLI_DOC.OTHER_ROOT_FILENAMES.FILENAME	Name of the file. Validators: • this filename could be a relative path • file type allowed: "file"

Variable and changelog documentation

🛈 Informations

doc.tables
disabled
Disabled: if "Generate document in format" is json or "Generated content" hasn't variable or changelog

Variable	Description
doc.tables.without_family `boolean` `mandatory` Command line: • -df, --doc.tables.without_family • -ndf, --doc.tables.no-without_family Environment variable: ROUGAILCLI_DOC.TABLES.WITHOUT_FAMILY	Do not add families in documentation. Default: false
doc.tables.with_commandline `boolean` `mandatory` Command line: • -dw, --doc.tables.with_commandline • -ndw, --doc.tables.no-with_commandline Environment variable: ROUGAILCLI_DOC.TABLES.WITH_COMMANDLINE	Add command line informations in documentation. Default: false
doc.tables.with_environment `boolean` `mandatory` Command line: • -de, --doc.tables.with_environment • -nde, --doc.tables.no-with_environment Environment variable: ROUGAILCLI_DOC.TABLES.WITH_ENVIRONMENT	Add environment variable informations in documentation. Default: false
doc.tables.environment_prefix `string` `mandatory` `disabled` Command line: -dd, --doc.tables.environment_prefix Environment variable: ROUGAILCLI_DOC.TABLES.ENVIRONMENT_PREFIX	Name of the default environment prefix. Validator: should only user uppercase characters Default: ROUGAIL Disabled: when "__.main_namespace" is not set or "Add environment variable informations in documentation" is false

Changelog documentation

🛈 Informations

doc.changelog
disabled
Disabled: if changelog in not in "Generated content"

Variable	Description
doc.changelog.previous_json_file `string` `mandatory` Command line: -dp, --doc.changelog.previous_json_file Environment variable: ROUGAILCLI_DOC.CHANGELOG.PREVIOUS_JSON_FILE	Previous description file in JSON format. To generate the changelog, you need to compare the old list of variables (in json format) with the current variables.

Examples configuration

🛈 Informations

doc.examples
disabled
Disabled: if example in not in "Generated content"

Variable	Description
doc.examples.comment `boolean` `mandatory` Command line: • -dx, --doc.examples.comment • -ndx, --doc.examples.no-comment Environment variable: ROUGAILCLI_DOC.EXAMPLES.COMMENT	Add description of variables and families when generate examples. Default: false
doc.examples.comment_column `integer` `mandatory` `disabled` Command line: --doc.examples.comment_column Environment variable: ROUGAILCLI_DOC.EXAMPLES.COMMENT_COLUMN	Comment in examples starts at column. Default: 30 Disabled: when the variable "Add description of variables and families when generate examples" has the value "false"

Three columns

Generate documentation

🛈 Informations

doc
disabled
Disabled: if doc is not set in "Select for output"

Variable	Description	Default value
doc.contents `choice` `multiple` `mandatory` `unique` Command line: -dc, --doc.contents Environment variable: ROUGAILCLI_DOC.CONTENTS	Generated content. You can generate three type of document. All variables ("variables"), an example file in YAML format ("example") or change log ("changelog"). Choices: • variables • example • changelog	• variables
doc.output_format `choice` `mandatory` Command line: -do, --doc.output_format Environment variable: ROUGAILCLI_DOC.OUTPUT_FORMAT	Generate document in format. Validator: the value json is not compatible with changelog and example "Generated content" Choices: • console • asciidoc • html • github • gitlab • json	console
doc.table_model `choice` `mandatory` Command line: -dm, --doc.table_model Environment variable: ROUGAILCLI_DOC.TABLE_MODEL	Generate document with this table model. Validator: the value json is not compatible with changelog and example "Generated content" Choices: • two_columns • three_columns • four_columns • five_columns • six_columns	two_columns
doc.title_level `integer` `mandatory` Command line: -dt, --doc.title_level Environment variable: ROUGAILCLI_DOC.TITLE_LEVEL	Starting title level.	1
doc.default_values `boolean` `mandatory` Command line: • --doc.default_values • --doc.no-default_values Environment variable: ROUGAILCLI_DOC.DEFAULT_VALUES	Modify values to document all variables. 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
doc.true_color `boolean` `mandatory` `disabled` Command line: • --doc.true_color • --doc.no-true_color Environment variable: ROUGAILCLI_DOC.TRUE_COLOR	Display documentation in console always with true color terminal. Disabled: when the variable "Generate document in format" hasn't the value "console"	false
doc.root `string` Command line: -dr, --doc.root Environment variable: ROUGAILCLI_DOC.ROOT	Document the child variables of the family.

The variables in this family are documented in another file

🛈 Informations

doc.other_root_filenames
This family contains lists of variable blocks.
disabled
Disabled: if "Document the child variables of the family" haven't any value

Variable	Description
doc.other_root_filenames.root_path `string` `multiple` `unique` Command line: --doc.other_root_filenames.root_path Environment variable: ROUGAILCLI_DOC.OTHER_ROOT_FILENAMES.ROOT_PATH	Family name.
doc.other_root_filenames.filename `UNIX filename` `mandatory` Command line: --doc.other_root_filenames.filename Environment variable: ROUGAILCLI_DOC.OTHER_ROOT_FILENAMES.FILENAME	Name of the file. Validators: • this filename could be a relative path • file type allowed: "file"

Variable and changelog documentation

🛈 Informations

doc.tables
disabled
Disabled: if "Generate document in format" is json or "Generated content" hasn't variable or changelog

Variable	Description	Default value
doc.tables.without_family `boolean` `mandatory` Command line: • -df, --doc.tables.without_family • -ndf, --doc.tables.no-without_family Environment variable: ROUGAILCLI_DOC.TABLES.WITHOUT_FAMILY	Do not add families in documentation.	false
doc.tables.with_commandline `boolean` `mandatory` Command line: • -dw, --doc.tables.with_commandline • -ndw, --doc.tables.no-with_commandline Environment variable: ROUGAILCLI_DOC.TABLES.WITH_COMMANDLINE	Add command line informations in documentation.	false
doc.tables.with_environment `boolean` `mandatory` Command line: • -de, --doc.tables.with_environment • -nde, --doc.tables.no-with_environment Environment variable: ROUGAILCLI_DOC.TABLES.WITH_ENVIRONMENT	Add environment variable informations in documentation.	false
doc.tables.environment_prefix `string` `mandatory` `disabled` Command line: -dd, --doc.tables.environment_prefix Environment variable: ROUGAILCLI_DOC.TABLES.ENVIRONMENT_PREFIX	Name of the default environment prefix. Validator: should only user uppercase characters Disabled: when "__.main_namespace" is not set or "Add environment variable informations in documentation" is false	ROUGAIL

Changelog documentation

🛈 Informations

doc.changelog
disabled
Disabled: if changelog in not in "Generated content"

Variable	Description
doc.changelog.previous_json_file `string` `mandatory` Command line: -dp, --doc.changelog.previous_json_file Environment variable: ROUGAILCLI_DOC.CHANGELOG.PREVIOUS_JSON_FILE	Previous description file in JSON format. To generate the changelog, you need to compare the old list of variables (in json format) with the current variables.

Examples configuration

🛈 Informations

doc.examples
disabled
Disabled: if example in not in "Generated content"

Variable	Description	Default value
doc.examples.comment `boolean` `mandatory` Command line: • -dx, --doc.examples.comment • -ndx, --doc.examples.no-comment Environment variable: ROUGAILCLI_DOC.EXAMPLES.COMMENT	Add description of variables and families when generate examples.	false
doc.examples.comment_column `integer` `mandatory` `disabled` Command line: --doc.examples.comment_column Environment variable: ROUGAILCLI_DOC.EXAMPLES.COMMENT_COLUMN	Comment in examples starts at column. Disabled: when the variable "Add description of variables and families when generate examples" has the value "false"	30

Four columns

Generate documentation

🛈 Informations

doc
disabled
Disabled: if doc is not set in "Select for output"

Variable	Description	Default value	Type
doc.contents `unique` Command line: -dc, --doc.contents Environment variable: ROUGAILCLI_DOC.CONTENTS	Generated content. You can generate three type of document. All variables ("variables"), an example file in YAML format ("example") or change log ("changelog"). Choices: • variables • example • changelog	• variables	`choice` `multiple` `mandatory`
doc.output_format Command line: -do, --doc.output_format Environment variable: ROUGAILCLI_DOC.OUTPUT_FORMAT	Generate document in format. Validator: the value json is not compatible with changelog and example "Generated content" Choices: • console • asciidoc • html • github • gitlab • json	console	`choice` `mandatory`
doc.table_model Command line: -dm, --doc.table_model Environment variable: ROUGAILCLI_DOC.TABLE_MODEL	Generate document with this table model. Validator: the value json is not compatible with changelog and example "Generated content" Choices: • two_columns • three_columns • four_columns • five_columns • six_columns	two_columns	`choice` `mandatory`
doc.title_level Command line: -dt, --doc.title_level Environment variable: ROUGAILCLI_DOC.TITLE_LEVEL	Starting title level.	1	`integer` `mandatory`
doc.default_values Command line: • --doc.default_values • --doc.no-default_values Environment variable: ROUGAILCLI_DOC.DEFAULT_VALUES	Modify values to document all variables. 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` `mandatory`
doc.true_color `disabled` Command line: • --doc.true_color • --doc.no-true_color Environment variable: ROUGAILCLI_DOC.TRUE_COLOR	Display documentation in console always with true color terminal. Disabled: when the variable "Generate document in format" hasn't the value "console"	false	`boolean` `mandatory`
doc.root Command line: -dr, --doc.root Environment variable: ROUGAILCLI_DOC.ROOT	Document the child variables of the family.		`string`

The variables in this family are documented in another file

🛈 Informations

doc.other_root_filenames
This family contains lists of variable blocks.
disabled
Disabled: if "Document the child variables of the family" haven't any value

Variable	Description	Type
doc.other_root_filenames.root_path `unique` Command line: --doc.other_root_filenames.root_path Environment variable: ROUGAILCLI_DOC.OTHER_ROOT_FILENAMES.ROOT_PATH	Family name.	`string` `multiple`
doc.other_root_filenames.filename Command line: --doc.other_root_filenames.filename Environment variable: ROUGAILCLI_DOC.OTHER_ROOT_FILENAMES.FILENAME	Name of the file. Validators: • this filename could be a relative path • file type allowed: "file"	`UNIX filename` `mandatory`

Variable and changelog documentation

🛈 Informations

doc.tables
disabled
Disabled: if "Generate document in format" is json or "Generated content" hasn't variable or changelog

Variable	Description	Default value	Type
doc.tables.without_family Command line: • -df, --doc.tables.without_family • -ndf, --doc.tables.no-without_family Environment variable: ROUGAILCLI_DOC.TABLES.WITHOUT_FAMILY	Do not add families in documentation.	false	`boolean` `mandatory`
doc.tables.with_commandline Command line: • -dw, --doc.tables.with_commandline • -ndw, --doc.tables.no-with_commandline Environment variable: ROUGAILCLI_DOC.TABLES.WITH_COMMANDLINE	Add command line informations in documentation.	false	`boolean` `mandatory`
doc.tables.with_environment Command line: • -de, --doc.tables.with_environment • -nde, --doc.tables.no-with_environment Environment variable: ROUGAILCLI_DOC.TABLES.WITH_ENVIRONMENT	Add environment variable informations in documentation.	false	`boolean` `mandatory`
doc.tables.environment_prefix `disabled` Command line: -dd, --doc.tables.environment_prefix Environment variable: ROUGAILCLI_DOC.TABLES.ENVIRONMENT_PREFIX	Name of the default environment prefix. Validator: should only user uppercase characters Disabled: when "__.main_namespace" is not set or "Add environment variable informations in documentation" is false	ROUGAIL	`string` `mandatory`

Changelog documentation

🛈 Informations

doc.changelog
disabled
Disabled: if changelog in not in "Generated content"

Variable	Description	Type
doc.changelog.previous_json_file Command line: -dp, --doc.changelog.previous_json_file Environment variable: ROUGAILCLI_DOC.CHANGELOG.PREVIOUS_JSON_FILE	Previous description file in JSON format. To generate the changelog, you need to compare the old list of variables (in json format) with the current variables.	`string` `mandatory`

Examples configuration

🛈 Informations

doc.examples
disabled
Disabled: if example in not in "Generated content"

Variable	Description	Default value	Type
doc.examples.comment Command line: • -dx, --doc.examples.comment • -ndx, --doc.examples.no-comment Environment variable: ROUGAILCLI_DOC.EXAMPLES.COMMENT	Add description of variables and families when generate examples.	false	`boolean` `mandatory`
doc.examples.comment_column `disabled` Command line: --doc.examples.comment_column Environment variable: ROUGAILCLI_DOC.EXAMPLES.COMMENT_COLUMN	Comment in examples starts at column. Disabled: when the variable "Add description of variables and families when generate examples" has the value "false"	30	`integer` `mandatory`

Five columns

Generate documentation

🛈 Informations

doc
disabled
Disabled: if doc is not set in "Select for output"

Variable	Description	Default value	Type	Access control
doc.contents `unique` Command line: -dc, --doc.contents Environment variable: ROUGAILCLI_DOC.CONTENTS	Generated content. You can generate three type of document. All variables ("variables"), an example file in YAML format ("example") or change log ("changelog"). Choices: • variables • example • changelog	• variables	`choice` `multiple` `mandatory`
doc.output_format Command line: -do, --doc.output_format Environment variable: ROUGAILCLI_DOC.OUTPUT_FORMAT	Generate document in format. Validator: the value json is not compatible with changelog and example "Generated content" Choices: • console • asciidoc • html • github • gitlab • json	console	`choice` `mandatory`
doc.table_model Command line: -dm, --doc.table_model Environment variable: ROUGAILCLI_DOC.TABLE_MODEL	Generate document with this table model. Validator: the value json is not compatible with changelog and example "Generated content" Choices: • two_columns • three_columns • four_columns • five_columns • six_columns	two_columns	`choice` `mandatory`
doc.title_level Command line: -dt, --doc.title_level Environment variable: ROUGAILCLI_DOC.TITLE_LEVEL	Starting title level.	1	`integer` `mandatory`
doc.default_values Command line: • --doc.default_values • --doc.no-default_values Environment variable: ROUGAILCLI_DOC.DEFAULT_VALUES	Modify values to document all variables. 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` `mandatory`
doc.true_color Command line: • --doc.true_color • --doc.no-true_color Environment variable: ROUGAILCLI_DOC.TRUE_COLOR	Display documentation in console always with true color terminal.	false	`boolean` `mandatory`	`disabled` Disabled: when the variable "Generate document in format" hasn't the value "console"
doc.root Command line: -dr, --doc.root Environment variable: ROUGAILCLI_DOC.ROOT	Document the child variables of the family.		`string`

The variables in this family are documented in another file

🛈 Informations

doc.other_root_filenames
This family contains lists of variable blocks.
disabled
Disabled: if "Document the child variables of the family" haven't any value

Variable	Description	Type
doc.other_root_filenames.root_path `unique` Command line: --doc.other_root_filenames.root_path Environment variable: ROUGAILCLI_DOC.OTHER_ROOT_FILENAMES.ROOT_PATH	Family name.	`string` `multiple`
doc.other_root_filenames.filename Command line: --doc.other_root_filenames.filename Environment variable: ROUGAILCLI_DOC.OTHER_ROOT_FILENAMES.FILENAME	Name of the file. Validators: • this filename could be a relative path • file type allowed: "file"	`UNIX filename` `mandatory`

Variable and changelog documentation

🛈 Informations

doc.tables
disabled
Disabled: if "Generate document in format" is json or "Generated content" hasn't variable or changelog

Variable	Description	Default value	Type	Access control
doc.tables.without_family Command line: • -df, --doc.tables.without_family • -ndf, --doc.tables.no-without_family Environment variable: ROUGAILCLI_DOC.TABLES.WITHOUT_FAMILY	Do not add families in documentation.	false	`boolean` `mandatory`
doc.tables.with_commandline Command line: • -dw, --doc.tables.with_commandline • -ndw, --doc.tables.no-with_commandline Environment variable: ROUGAILCLI_DOC.TABLES.WITH_COMMANDLINE	Add command line informations in documentation.	false	`boolean` `mandatory`
doc.tables.with_environment Command line: • -de, --doc.tables.with_environment • -nde, --doc.tables.no-with_environment Environment variable: ROUGAILCLI_DOC.TABLES.WITH_ENVIRONMENT	Add environment variable informations in documentation.	false	`boolean` `mandatory`
doc.tables.environment_prefix Command line: -dd, --doc.tables.environment_prefix Environment variable: ROUGAILCLI_DOC.TABLES.ENVIRONMENT_PREFIX	Name of the default environment prefix. Validator: should only user uppercase characters	ROUGAIL	`string` `mandatory`	`disabled` Disabled: when "__.main_namespace" is not set or "Add environment variable informations in documentation" is false

Changelog documentation

🛈 Informations

doc.changelog
disabled
Disabled: if changelog in not in "Generated content"

Variable	Description	Type
doc.changelog.previous_json_file Command line: -dp, --doc.changelog.previous_json_file Environment variable: ROUGAILCLI_DOC.CHANGELOG.PREVIOUS_JSON_FILE	Previous description file in JSON format. To generate the changelog, you need to compare the old list of variables (in json format) with the current variables.	`string` `mandatory`

Examples configuration

🛈 Informations

doc.examples
disabled
Disabled: if example in not in "Generated content"

Variable	Description	Default value	Type	Access control
doc.examples.comment Command line: • -dx, --doc.examples.comment • -ndx, --doc.examples.no-comment Environment variable: ROUGAILCLI_DOC.EXAMPLES.COMMENT	Add description of variables and families when generate examples.	false	`boolean` `mandatory`
doc.examples.comment_column Command line: --doc.examples.comment_column Environment variable: ROUGAILCLI_DOC.EXAMPLES.COMMENT_COLUMN	Comment in examples starts at column.	30	`integer` `mandatory`	`disabled` Disabled: when the variable "Add description of variables and families when generate examples" has the value "false"

Six columns

Generate documentation

🛈 Informations

doc
disabled
Disabled: if doc is not set in "Select for output"

Variable	Description	Default value	Type	Access control	Validator
doc.contents Command line: -dc, --doc.contents Environment variable: ROUGAILCLI_DOC.CONTENTS	Generated content. You can generate three type of document. All variables ("variables"), an example file in YAML format ("example") or change log ("changelog"). Choices: • variables • example • changelog	• variables	`choice` `multiple` `mandatory`		`unique`
doc.output_format Command line: -do, --doc.output_format Environment variable: ROUGAILCLI_DOC.OUTPUT_FORMAT	Generate document in format. Choices: • console • asciidoc • html • github • gitlab • json	console	`choice` `mandatory`		The value json is not compatible with changelog and example "Generated content".
doc.table_model Command line: -dm, --doc.table_model Environment variable: ROUGAILCLI_DOC.TABLE_MODEL	Generate document with this table model. Choices: • two_columns • three_columns • four_columns • five_columns • six_columns	two_columns	`choice` `mandatory`		The value json is not compatible with changelog and example "Generated content".
doc.title_level Command line: -dt, --doc.title_level Environment variable: ROUGAILCLI_DOC.TITLE_LEVEL	Starting title level.	1	`integer` `mandatory`
doc.default_values Command line: • --doc.default_values • --doc.no-default_values Environment variable: ROUGAILCLI_DOC.DEFAULT_VALUES	Modify values to document all variables. 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` `mandatory`
doc.true_color Command line: • --doc.true_color • --doc.no-true_color Environment variable: ROUGAILCLI_DOC.TRUE_COLOR	Display documentation in console always with true color terminal.	false	`boolean` `mandatory`	`disabled` Disabled: when the variable "Generate document in format" hasn't the value "console"
doc.root Command line: -dr, --doc.root Environment variable: ROUGAILCLI_DOC.ROOT	Document the child variables of the family.		`string`

The variables in this family are documented in another file

🛈 Informations

doc.other_root_filenames
This family contains lists of variable blocks.
disabled
Disabled: if "Document the child variables of the family" haven't any value

Variable	Description	Type	Validator
doc.other_root_filenames.root_path Command line: --doc.other_root_filenames.root_path Environment variable: ROUGAILCLI_DOC.OTHER_ROOT_FILENAMES.ROOT_PATH	Family name.	`string` `multiple`	`unique`
doc.other_root_filenames.filename Command line: --doc.other_root_filenames.filename Environment variable: ROUGAILCLI_DOC.OTHER_ROOT_FILENAMES.FILENAME	Name of the file.	`UNIX filename` `mandatory`	• this filename could be a relative path • file type allowed: "file".

Variable and changelog documentation

🛈 Informations

doc.tables
disabled
Disabled: if "Generate document in format" is json or "Generated content" hasn't variable or changelog

Variable	Description	Default value	Type	Access control	Validator
doc.tables.without_family Command line: • -df, --doc.tables.without_family • -ndf, --doc.tables.no-without_family Environment variable: ROUGAILCLI_DOC.TABLES.WITHOUT_FAMILY	Do not add families in documentation.	false	`boolean` `mandatory`
doc.tables.with_commandline Command line: • -dw, --doc.tables.with_commandline • -ndw, --doc.tables.no-with_commandline Environment variable: ROUGAILCLI_DOC.TABLES.WITH_COMMANDLINE	Add command line informations in documentation.	false	`boolean` `mandatory`
doc.tables.with_environment Command line: • -de, --doc.tables.with_environment • -nde, --doc.tables.no-with_environment Environment variable: ROUGAILCLI_DOC.TABLES.WITH_ENVIRONMENT	Add environment variable informations in documentation.	false	`boolean` `mandatory`
doc.tables.environment_prefix Command line: -dd, --doc.tables.environment_prefix Environment variable: ROUGAILCLI_DOC.TABLES.ENVIRONMENT_PREFIX	Name of the default environment prefix.	ROUGAIL	`string` `mandatory`	`disabled` Disabled: when "__.main_namespace" is not set or "Add environment variable informations in documentation" is false	Should only user uppercase characters.

Changelog documentation

🛈 Informations

doc.changelog
disabled
Disabled: if changelog in not in "Generated content"

Variable	Description	Type
doc.changelog.previous_json_file Command line: -dp, --doc.changelog.previous_json_file Environment variable: ROUGAILCLI_DOC.CHANGELOG.PREVIOUS_JSON_FILE	Previous description file in JSON format. To generate the changelog, you need to compare the old list of variables (in json format) with the current variables.	`string` `mandatory`

Examples configuration

🛈 Informations

doc.examples
disabled
Disabled: if example in not in "Generated content"

Variable	Description	Default value	Type	Access control
doc.examples.comment Command line: • -dx, --doc.examples.comment • -ndx, --doc.examples.no-comment Environment variable: ROUGAILCLI_DOC.EXAMPLES.COMMENT	Add description of variables and families when generate examples.	false	`boolean` `mandatory`
doc.examples.comment_column Command line: --doc.examples.comment_column Environment variable: ROUGAILCLI_DOC.EXAMPLES.COMMENT_COLUMN	Comment in examples starts at column.	30	`integer` `mandatory`	`disabled` Disabled: when the variable "Add description of variables and families when generate examples" has the value "false"