| locale | ||
| src/rougail/output_doc | ||
| tests | ||
| CHANGELOG.md | ||
| LICENSE | ||
| pyproject.toml | ||
| README.md | ||
Table of Contents
Two columns
Generate documentation
🛈 Informations
doc
basicdisabled
Disabled: when "Generate documentation" is not set in "Select for output"
| Variable | Description |
|---|---|
doc.title_levelinteger standard mandatoryCommand line: -dt, --doc.title_level Environment variable: ROUGAILCLI_DOC.TITLE_LEVEL |
Starting title level. Default: 1 |
doc.contentschoice multiple standard mandatory uniqueCommand line: -dc, --doc.contents Environment variable: ROUGAILCLI_DOC.CONTENTS |
Generated content. Choices: • variables ← (default) • example • changelog |
doc.previous_json_filestring basic mandatory disabledCommand line: -dp, --doc.previous_json_file Environment variable: ROUGAILCLI_DOC.PREVIOUS_JSON_FILE |
Previous description file in JSON format. Disabled: changelog is not selected in "Generated content" |
doc.without_familyboolean standard mandatory disabledCommand line: • -df, --doc.without_family • -ndf, --doc.no-without_family Environment variable: ROUGAILCLI_DOC.WITHOUT_FAMILY |
Do not add families in documentation. Default: false Disabled: if "Generate document in format" is json or "Generated content" hasn't variable or changelog |
doc.rootstring standardCommand line: -dr, --doc.root Environment variable: ROUGAILCLI_DOC.ROOT |
Document the variables from this family. |
doc.with_commandlineboolean standard mandatory disabledCommand line: • -dw, --doc.with_commandline • -ndw, --doc.no-with_commandline Environment variable: ROUGAILCLI_DOC.WITH_COMMANDLINE |
Add command line informations in documentation. Default: false Disabled: if "Generate document in format" is json or "Generated content" hasn't variable or changelog |
doc.with_environmentboolean standard mandatory disabledCommand line: • -de, --doc.with_environment • -nde, --doc.no-with_environment Environment variable: ROUGAILCLI_DOC.WITH_ENVIRONMENT |
Add environment variable informations in documentation. Default: false Disabled: if "Generate document in format" is json or "Generated content" hasn't variable or changelog |
doc.environment_prefixstring standard mandatory disabledCommand line: -dd, --doc.environment_prefix Environment variable: ROUGAILCLI_DOC.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 |
doc.disabled_modesstring multiple standard disabled uniqueCommand line: --doc.disabled_modes Environment variable: ROUGAILCLI_DOC.DISABLED_MODES |
Disable documentation for variables with those modes. Validator: verify if disable modes already exists Disabled: disabled when there is no mode available |
doc.default_valuesboolean standard mandatoryCommand 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.comment_examplesboolean standard mandatory disabledCommand line: • -dx, --doc.comment_examples • -ndx, --doc.no-comment_examples Environment variable: ROUGAILCLI_DOC.COMMENT_EXAMPLES |
Add description of variables and families when generate examples. Default: false Disabled: disabled when example in not in contents |
doc.comment_examples_columninteger standard mandatory disabledCommand line: --doc.comment_examples_column Environment variable: ROUGAILCLI_DOC.COMMENT_EXAMPLES_COLUMN |
Comment in examples starts at column. Default: 30 Disabled: when the variable "Add description of variables and families when generate examples" is accessible and has the value "false" |
doc.output_formatchoice standard mandatoryCommand line: -do, --doc.output_format Environment variable: ROUGAILCLI_DOC.OUTPUT_FORMAT |
Generate document in format. Validator: json output_format is not compatible with "changelog" and "example" contents Choices: • console ← (default) • asciidoc • html • github • gitlab • json |
doc.table_modelchoice standard mandatoryCommand line: -dm, --doc.table_model Environment variable: ROUGAILCLI_DOC.TABLE_MODEL |
Generate document inside table model. Validator: json output_format is not compatible with "changelog" and "example" contents Choices: • two_columns ← (default) • three_columns • four_columns • five_columns • six_columns |
doc.true_color_terminalboolean standard mandatoryCommand line: • --doc.true_color_terminal • --doc.no-true_color_terminal Environment variable: ROUGAILCLI_DOC.TRUE_COLOR_TERMINAL |
Force true color terminal. Default: false |
Families or variables for this family are in an other file name
🛈 Informations
doc.other_root_filenames
This family contains lists of variable blocks.
basicdisabled
Disabled: if "Document the variables from this family" haven't any value
| Variable | Description |
|---|---|
doc.other_root_filenames.root_pathstring multiple standard uniqueCommand line: --doc.other_root_filenames.root_path Environment variable: ROUGAILCLI_DOC.OTHER_ROOT_FILENAMES.ROOT_PATH |
Root family name. |
doc.other_root_filenames.filenameUNIX filename basic mandatoryCommand 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: "directory" and "file" |
Three columns
Generate documentation
🛈 Informations
doc
basicdisabled
Disabled: when "Generate documentation" is not set in "Select for output"
| Variable | Description | Default value |
|---|---|---|
doc.title_levelinteger standard mandatoryCommand line: -dt, --doc.title_level Environment variable: ROUGAILCLI_DOC.TITLE_LEVEL |
Starting title level. | 1 |
doc.contentschoice multiple standard mandatory uniqueCommand line: -dc, --doc.contents Environment variable: ROUGAILCLI_DOC.CONTENTS |
Generated content. Choices: • variables • example • changelog |
• variables |
doc.previous_json_filestring basic mandatory disabledCommand line: -dp, --doc.previous_json_file Environment variable: ROUGAILCLI_DOC.PREVIOUS_JSON_FILE |
Previous description file in JSON format. Disabled: changelog is not selected in "Generated content" |
|
doc.without_familyboolean standard mandatory disabledCommand line: • -df, --doc.without_family • -ndf, --doc.no-without_family Environment variable: ROUGAILCLI_DOC.WITHOUT_FAMILY |
Do not add families in documentation. Disabled: if "Generate document in format" is json or "Generated content" hasn't variable or changelog |
false |
doc.rootstring standardCommand line: -dr, --doc.root Environment variable: ROUGAILCLI_DOC.ROOT |
Document the variables from this family. | |
doc.with_commandlineboolean standard mandatory disabledCommand line: • -dw, --doc.with_commandline • -ndw, --doc.no-with_commandline Environment variable: ROUGAILCLI_DOC.WITH_COMMANDLINE |
Add command line informations in documentation. Disabled: if "Generate document in format" is json or "Generated content" hasn't variable or changelog |
false |
doc.with_environmentboolean standard mandatory disabledCommand line: • -de, --doc.with_environment • -nde, --doc.no-with_environment Environment variable: ROUGAILCLI_DOC.WITH_ENVIRONMENT |
Add environment variable informations in documentation. Disabled: if "Generate document in format" is json or "Generated content" hasn't variable or changelog |
false |
doc.environment_prefixstring standard mandatory disabledCommand line: -dd, --doc.environment_prefix Environment variable: ROUGAILCLI_DOC.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 |
doc.disabled_modesstring multiple standard disabled uniqueCommand line: --doc.disabled_modes Environment variable: ROUGAILCLI_DOC.DISABLED_MODES |
Disable documentation for variables with those modes. Validator: verify if disable modes already exists Disabled: disabled when there is no mode available |
|
doc.default_valuesboolean standard mandatoryCommand 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.comment_examplesboolean standard mandatory disabledCommand line: • -dx, --doc.comment_examples • -ndx, --doc.no-comment_examples Environment variable: ROUGAILCLI_DOC.COMMENT_EXAMPLES |
Add description of variables and families when generate examples. Disabled: disabled when example in not in contents |
false |
doc.comment_examples_columninteger standard mandatory disabledCommand line: --doc.comment_examples_column Environment variable: ROUGAILCLI_DOC.COMMENT_EXAMPLES_COLUMN |
Comment in examples starts at column. Disabled: when the variable "Add description of variables and families when generate examples" is accessible and has the value "false" |
30 |
doc.output_formatchoice standard mandatoryCommand line: -do, --doc.output_format Environment variable: ROUGAILCLI_DOC.OUTPUT_FORMAT |
Generate document in format. Validator: json output_format is not compatible with "changelog" and "example" contents Choices: • console • asciidoc • html • github • gitlab • json |
console |
doc.table_modelchoice standard mandatoryCommand line: -dm, --doc.table_model Environment variable: ROUGAILCLI_DOC.TABLE_MODEL |
Generate document inside table model. Validator: json output_format is not compatible with "changelog" and "example" contents Choices: • two_columns • three_columns • four_columns • five_columns • six_columns |
two_columns |
doc.true_color_terminalboolean standard mandatoryCommand line: • --doc.true_color_terminal • --doc.no-true_color_terminal Environment variable: ROUGAILCLI_DOC.TRUE_COLOR_TERMINAL |
Force true color terminal. | false |
Families or variables for this family are in an other file name
🛈 Informations
doc.other_root_filenames
This family contains lists of variable blocks.
basicdisabled
Disabled: if "Document the variables from this family" haven't any value
| Variable | Description |
|---|---|
doc.other_root_filenames.root_pathstring multiple standard uniqueCommand line: --doc.other_root_filenames.root_path Environment variable: ROUGAILCLI_DOC.OTHER_ROOT_FILENAMES.ROOT_PATH |
Root family name. |
doc.other_root_filenames.filenameUNIX filename basic mandatoryCommand 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: "directory" and "file" |
Four columns
Generate documentation
🛈 Informations
doc
basicdisabled
Disabled: when "Generate documentation" is not set in "Select for output"
| Variable | Description | Default value | Type |
|---|---|---|---|
doc.title_levelstandardCommand line: -dt, --doc.title_level Environment variable: ROUGAILCLI_DOC.TITLE_LEVEL |
Starting title level. | 1 | integer mandatory |
doc.contentsstandard uniqueCommand line: -dc, --doc.contents Environment variable: ROUGAILCLI_DOC.CONTENTS |
Generated content. Choices: • variables • example • changelog |
• variables | choice multiple mandatory |
doc.previous_json_filebasic disabledCommand line: -dp, --doc.previous_json_file Environment variable: ROUGAILCLI_DOC.PREVIOUS_JSON_FILE |
Previous description file in JSON format. Disabled: changelog is not selected in "Generated content" |
string mandatory |
|
doc.without_familystandard disabledCommand line: • -df, --doc.without_family • -ndf, --doc.no-without_family Environment variable: ROUGAILCLI_DOC.WITHOUT_FAMILY |
Do not add families in documentation. Disabled: if "Generate document in format" is json or "Generated content" hasn't variable or changelog |
false | boolean mandatory |
doc.rootstandardCommand line: -dr, --doc.root Environment variable: ROUGAILCLI_DOC.ROOT |
Document the variables from this family. | string |
|
doc.with_commandlinestandard disabledCommand line: • -dw, --doc.with_commandline • -ndw, --doc.no-with_commandline Environment variable: ROUGAILCLI_DOC.WITH_COMMANDLINE |
Add command line informations in documentation. Disabled: if "Generate document in format" is json or "Generated content" hasn't variable or changelog |
false | boolean mandatory |
doc.with_environmentstandard disabledCommand line: • -de, --doc.with_environment • -nde, --doc.no-with_environment Environment variable: ROUGAILCLI_DOC.WITH_ENVIRONMENT |
Add environment variable informations in documentation. Disabled: if "Generate document in format" is json or "Generated content" hasn't variable or changelog |
false | boolean mandatory |
doc.environment_prefixstandard disabledCommand line: -dd, --doc.environment_prefix Environment variable: ROUGAILCLI_DOC.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 |
doc.disabled_modesstandard disabled uniqueCommand line: --doc.disabled_modes Environment variable: ROUGAILCLI_DOC.DISABLED_MODES |
Disable documentation for variables with those modes. Validator: verify if disable modes already exists Disabled: disabled when there is no mode available |
string multiple |
|
doc.default_valuesstandardCommand 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.comment_examplesstandard disabledCommand line: • -dx, --doc.comment_examples • -ndx, --doc.no-comment_examples Environment variable: ROUGAILCLI_DOC.COMMENT_EXAMPLES |
Add description of variables and families when generate examples. Disabled: disabled when example in not in contents |
false | boolean mandatory |
doc.comment_examples_columnstandard disabledCommand line: --doc.comment_examples_column Environment variable: ROUGAILCLI_DOC.COMMENT_EXAMPLES_COLUMN |
Comment in examples starts at column. Disabled: when the variable "Add description of variables and families when generate examples" is accessible and has the value "false" |
30 | integer mandatory |
doc.output_formatstandardCommand line: -do, --doc.output_format Environment variable: ROUGAILCLI_DOC.OUTPUT_FORMAT |
Generate document in format. Validator: json output_format is not compatible with "changelog" and "example" contents Choices: • console • asciidoc • html • github • gitlab • json |
console | choice mandatory |
doc.table_modelstandardCommand line: -dm, --doc.table_model Environment variable: ROUGAILCLI_DOC.TABLE_MODEL |
Generate document inside table model. Validator: json output_format is not compatible with "changelog" and "example" contents Choices: • two_columns • three_columns • four_columns • five_columns • six_columns |
two_columns | choice mandatory |
doc.true_color_terminalstandardCommand line: • --doc.true_color_terminal • --doc.no-true_color_terminal Environment variable: ROUGAILCLI_DOC.TRUE_COLOR_TERMINAL |
Force true color terminal. | false | boolean mandatory |
Families or variables for this family are in an other file name
🛈 Informations
doc.other_root_filenames
This family contains lists of variable blocks.
basicdisabled
Disabled: if "Document the variables from this family" haven't any value
| Variable | Description | Type |
|---|---|---|
doc.other_root_filenames.root_pathstandard uniqueCommand line: --doc.other_root_filenames.root_path Environment variable: ROUGAILCLI_DOC.OTHER_ROOT_FILENAMES.ROOT_PATH |
Root family name. | string multiple |
doc.other_root_filenames.filenamebasicCommand 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: "directory" and "file" |
UNIX filename mandatory |
Five columns
Generate documentation
🛈 Informations
doc
basicdisabled
Disabled: when "Generate documentation" is not set in "Select for output"
| Variable | Description | Default value | Type | Access control |
|---|---|---|---|---|
| doc.title_level Command line: -dt, --doc.title_level Environment variable: ROUGAILCLI_DOC.TITLE_LEVEL |
Starting title level. | 1 | integer mandatory |
standard |
doc.contentsuniqueCommand line: -dc, --doc.contents Environment variable: ROUGAILCLI_DOC.CONTENTS |
Generated content. Choices: • variables • example • changelog |
• variables | choice multiple mandatory |
standard |
| doc.previous_json_file Command line: -dp, --doc.previous_json_file Environment variable: ROUGAILCLI_DOC.PREVIOUS_JSON_FILE |
Previous description file in JSON format. | string mandatory |
basic disabledDisabled: changelog is not selected in "Generated content" |
|
| doc.without_family Command line: • -df, --doc.without_family • -ndf, --doc.no-without_family Environment variable: ROUGAILCLI_DOC.WITHOUT_FAMILY |
Do not add families in documentation. | false | boolean mandatory |
standard disabledDisabled: if "Generate document in format" is json or "Generated content" hasn't variable or changelog |
| doc.root Command line: -dr, --doc.root Environment variable: ROUGAILCLI_DOC.ROOT |
Document the variables from this family. | string |
standard |
|
| doc.with_commandline Command line: • -dw, --doc.with_commandline • -ndw, --doc.no-with_commandline Environment variable: ROUGAILCLI_DOC.WITH_COMMANDLINE |
Add command line informations in documentation. | false | boolean mandatory |
standard disabledDisabled: if "Generate document in format" is json or "Generated content" hasn't variable or changelog |
| doc.with_environment Command line: • -de, --doc.with_environment • -nde, --doc.no-with_environment Environment variable: ROUGAILCLI_DOC.WITH_ENVIRONMENT |
Add environment variable informations in documentation. | false | boolean mandatory |
standard disabledDisabled: if "Generate document in format" is json or "Generated content" hasn't variable or changelog |
| doc.environment_prefix Command line: -dd, --doc.environment_prefix Environment variable: ROUGAILCLI_DOC.ENVIRONMENT_PREFIX |
Name of the default environment prefix. Validator: should only user uppercase characters |
ROUGAIL | string mandatory |
standard disabledDisabled: when "__.main_namespace" is not set or "Add environment variable informations in documentation" is false |
doc.disabled_modesuniqueCommand line: --doc.disabled_modes Environment variable: ROUGAILCLI_DOC.DISABLED_MODES |
Disable documentation for variables with those modes. Validator: verify if disable modes already exists |
string multiple |
standard disabledDisabled: disabled when there is no mode available |
|
| 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 |
standard |
| doc.comment_examples Command line: • -dx, --doc.comment_examples • -ndx, --doc.no-comment_examples Environment variable: ROUGAILCLI_DOC.COMMENT_EXAMPLES |
Add description of variables and families when generate examples. | false | boolean mandatory |
standard disabledDisabled: disabled when example in not in contents |
| doc.comment_examples_column Command line: --doc.comment_examples_column Environment variable: ROUGAILCLI_DOC.COMMENT_EXAMPLES_COLUMN |
Comment in examples starts at column. | 30 | integer mandatory |
standard disabledDisabled: when the variable "Add description of variables and families when generate examples" is accessible and has the value "false" |
| doc.output_format Command line: -do, --doc.output_format Environment variable: ROUGAILCLI_DOC.OUTPUT_FORMAT |
Generate document in format. Validator: json output_format is not compatible with "changelog" and "example" contents Choices: • console • asciidoc • html • github • gitlab • json |
console | choice mandatory |
standard |
| doc.table_model Command line: -dm, --doc.table_model Environment variable: ROUGAILCLI_DOC.TABLE_MODEL |
Generate document inside table model. Validator: json output_format is not compatible with "changelog" and "example" contents Choices: • two_columns • three_columns • four_columns • five_columns • six_columns |
two_columns | choice mandatory |
standard |
| doc.true_color_terminal Command line: • --doc.true_color_terminal • --doc.no-true_color_terminal Environment variable: ROUGAILCLI_DOC.TRUE_COLOR_TERMINAL |
Force true color terminal. | false | boolean mandatory |
standard |
Families or variables for this family are in an other file name
🛈 Informations
doc.other_root_filenames
This family contains lists of variable blocks.
basicdisabled
Disabled: if "Document the variables from this family" haven't any value
| Variable | Description | Type | Access control |
|---|---|---|---|
doc.other_root_filenames.root_pathuniqueCommand line: --doc.other_root_filenames.root_path Environment variable: ROUGAILCLI_DOC.OTHER_ROOT_FILENAMES.ROOT_PATH |
Root family name. | string multiple |
standard |
| 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: "directory" and "file" |
UNIX filename mandatory |
basic |
Six columns
Generate documentation
🛈 Informations
doc
basicdisabled
Disabled: when "Generate documentation" is not set in "Select for output"
| Variable | Description | Default value | Type | Access control | Validator |
|---|---|---|---|---|---|
| doc.title_level Command line: -dt, --doc.title_level Environment variable: ROUGAILCLI_DOC.TITLE_LEVEL |
Starting title level. | 1 | integer mandatory |
standard |
|
| doc.contents Command line: -dc, --doc.contents Environment variable: ROUGAILCLI_DOC.CONTENTS |
Generated content. Choices: • variables • example • changelog |
• variables | choice multiple mandatory |
standard |
unique |
| doc.previous_json_file Command line: -dp, --doc.previous_json_file Environment variable: ROUGAILCLI_DOC.PREVIOUS_JSON_FILE |
Previous description file in JSON format. | string mandatory |
basic disabledDisabled: changelog is not selected in "Generated content" |
||
| doc.without_family Command line: • -df, --doc.without_family • -ndf, --doc.no-without_family Environment variable: ROUGAILCLI_DOC.WITHOUT_FAMILY |
Do not add families in documentation. | false | boolean mandatory |
standard disabledDisabled: if "Generate document in format" is json or "Generated content" hasn't variable or changelog |
|
| doc.root Command line: -dr, --doc.root Environment variable: ROUGAILCLI_DOC.ROOT |
Document the variables from this family. | string |
standard |
||
| doc.with_commandline Command line: • -dw, --doc.with_commandline • -ndw, --doc.no-with_commandline Environment variable: ROUGAILCLI_DOC.WITH_COMMANDLINE |
Add command line informations in documentation. | false | boolean mandatory |
standard disabledDisabled: if "Generate document in format" is json or "Generated content" hasn't variable or changelog |
|
| doc.with_environment Command line: • -de, --doc.with_environment • -nde, --doc.no-with_environment Environment variable: ROUGAILCLI_DOC.WITH_ENVIRONMENT |
Add environment variable informations in documentation. | false | boolean mandatory |
standard disabledDisabled: if "Generate document in format" is json or "Generated content" hasn't variable or changelog |
|
| doc.environment_prefix Command line: -dd, --doc.environment_prefix Environment variable: ROUGAILCLI_DOC.ENVIRONMENT_PREFIX |
Name of the default environment prefix. | ROUGAIL | string mandatory |
standard disabledDisabled: when "__.main_namespace" is not set or "Add environment variable informations in documentation" is false |
Should only user uppercase characters. |
| doc.disabled_modes Command line: --doc.disabled_modes Environment variable: ROUGAILCLI_DOC.DISABLED_MODES |
Disable documentation for variables with those modes. | string multiple |
standard disabledDisabled: disabled when there is no mode available |
uniqueVerify if disable modes already exists. |
|
| 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 |
standard |
|
| doc.comment_examples Command line: • -dx, --doc.comment_examples • -ndx, --doc.no-comment_examples Environment variable: ROUGAILCLI_DOC.COMMENT_EXAMPLES |
Add description of variables and families when generate examples. | false | boolean mandatory |
standard disabledDisabled: disabled when example in not in contents |
|
| doc.comment_examples_column Command line: --doc.comment_examples_column Environment variable: ROUGAILCLI_DOC.COMMENT_EXAMPLES_COLUMN |
Comment in examples starts at column. | 30 | integer mandatory |
standard disabledDisabled: when the variable "Add description of variables and families when generate examples" is accessible and has the value "false" |
|
| 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 |
standard |
Json output_format is not compatible with "changelog" and "example" contents. |
| doc.table_model Command line: -dm, --doc.table_model Environment variable: ROUGAILCLI_DOC.TABLE_MODEL |
Generate document inside table model. Choices: • two_columns • three_columns • four_columns • five_columns • six_columns |
two_columns | choice mandatory |
standard |
Json output_format is not compatible with "changelog" and "example" contents. |
| doc.true_color_terminal Command line: • --doc.true_color_terminal • --doc.no-true_color_terminal Environment variable: ROUGAILCLI_DOC.TRUE_COLOR_TERMINAL |
Force true color terminal. | false | boolean mandatory |
standard |
Families or variables for this family are in an other file name
🛈 Informations
doc.other_root_filenames
This family contains lists of variable blocks.
basicdisabled
Disabled: if "Document the variables from this family" haven't any value
| Variable | Description | Type | Access control | Validator |
|---|---|---|---|---|
| doc.other_root_filenames.root_path Command line: --doc.other_root_filenames.root_path Environment variable: ROUGAILCLI_DOC.OTHER_ROOT_FILENAMES.ROOT_PATH |
Root family name. | string multiple |
standard |
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 |
basic |
• this filename could be a relative path • file type allowed: "directory" and "file". |