stove/rougail-output-doc
2
0
Fork 0
Code Issues 1 Pull requests Projects Releases Packages Wiki Activity
rougail-output-doc/README.md

225 lines
76 KiB
Markdown
Raw Normal View History

feat: personalise column number
2025-11-29 22:21:06 +01:00
---
gitea: none
include_toc: true
---
# Two columns
## Generate documentation
> **🛈 Informations**
>
> **<a id="doc" name="doc">doc</a>**\
> `basic` *`disabled`*\
> **Disabled**: when "[Generate documentation](#doc)" is not set in "[Select for output](#step.output)"
| Variable | Description |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **<a id="doc.title_level" name="doc.title_level">doc.title_level</a>**<br/>[`integer`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory`<br/>**Command line**: -dt, --doc.title_level<br/>**Environment variable**: ROUGAILCLI_DOC.TITLE_LEVEL | Starting title level.<br/>**Default**: 1 |
| **<a id="doc.contents" name="doc.contents">doc.contents</a>**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` `standard` `mandatory` `unique`<br/>**Command line**: -dc, --doc.contents<br/>**Environment variable**: ROUGAILCLI_DOC.CONTENTS | Generated content.<br/>**Choices**: <br/>•&nbsp;variables **← (default)**<br/>•&nbsp;example<br/>•&nbsp;changelog |
| **<a id="doc.previous_json_file" name="doc.previous_json_file">doc.previous_json_file</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` *`disabled`*<br/>**Command line**: -dp, --doc.previous_json_file<br/>**Environment variable**: ROUGAILCLI_DOC.PREVIOUS_JSON_FILE | Previous description file in JSON format.<br/>**Disabled**: changelog is not selected in "[Generated content](#doc.contents)" |
| **<a id="doc.without_family" name="doc.without_family">doc.without_family</a>**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` *`disabled`*<br/>**Command line**: <br/>•&nbsp;-df, --doc.without_family<br/>•&nbsp;-ndf, --doc.no-without_family<br/>**Environment variable**: ROUGAILCLI_DOC.WITHOUT_FAMILY | Do not add families in documentation.<br/>**Default**: false<br/>**Disabled**: if "[Generate document in format](#doc.output_format)" is json or "[Generated content](#doc.contents)" hasn't variable or changelog |
| **<a id="doc.root" name="doc.root">doc.root</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard`<br/>**Command line**: -dr, --doc.root<br/>**Environment variable**: ROUGAILCLI_DOC.ROOT | Document the variables from this family. |
| **<a id="doc.with_commandline" name="doc.with_commandline">doc.with_commandline</a>**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` *`disabled`*<br/>**Command line**: <br/>•&nbsp;-dw, --doc.with_commandline<br/>•&nbsp;-ndw, --doc.no-with_commandline<br/>**Environment variable**: ROUGAILCLI_DOC.WITH_COMMANDLINE | Add command line informations in documentation.<br/>**Default**: false<br/>**Disabled**: if "[Generate document in format](#doc.output_format)" is json or "[Generated content](#doc.contents)" hasn't variable or changelog |
| **<a id="doc.with_environment" name="doc.with_environment">doc.with_environment</a>**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` *`disabled`*<br/>**Command line**: <br/>•&nbsp;-de, --doc.with_environment<br/>•&nbsp;-nde, --doc.no-with_environment<br/>**Environment variable**: ROUGAILCLI_DOC.WITH_ENVIRONMENT | Add environment variable informations in documentation.<br/>**Default**: false<br/>**Disabled**: if "[Generate document in format](#doc.output_format)" is json or "[Generated content](#doc.contents)" hasn't variable or changelog |
| **<a id="doc.environment_prefix" name="doc.environment_prefix">doc.environment_prefix</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` *`disabled`*<br/>**Command line**: -dd, --doc.environment_prefix<br/>**Environment variable**: ROUGAILCLI_DOC.ENVIRONMENT_PREFIX | Name of the default environment prefix.<br/>**Validator**: should only user uppercase characters<br/>**Default**: ROUGAIL<br/>**Disabled**: when "__.main_namespace" is not set or "[Add environment variable informations in documentation](#doc.with_environment)" is false |
| **<a id="doc.disabled_modes" name="doc.disabled_modes">doc.disabled_modes</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` `standard` *`disabled`* `unique`<br/>**Command line**: --doc.disabled_modes<br/>**Environment variable**: ROUGAILCLI_DOC.DISABLED_MODES | Disable documentation for variables with those modes.<br/>**Validator**: verify if disable modes already exists<br/>**Disabled**: disabled when there is no mode available |
| **<a id="doc.change_default_value" name="doc.change_default_value">doc.change_default_value</a>**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory`<br/>**Command line**: <br/>•&nbsp;--doc.change_default_value<br/>•&nbsp;--doc.no-change_default_value<br/>**Environment variable**: ROUGAILCLI_DOC.CHANGE_DEFAULT_VALUE | Modify values to document leaderships and dynamics families.<br/>**Default**: true |
| **<a id="doc.comment_examples" name="doc.comment_examples">doc.comment_examples</a>**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` *`disabled`*<br/>**Command line**: <br/>•&nbsp;-dx, --doc.comment_examples<br/>•&nbsp;-ndx, --doc.no-comment_examples<br/>**Environment variable**: ROUGAILCLI_DOC.COMMENT_EXAMPLES | Add description of variables and families when generate examples.<br/>**Default**: false<br/>**Disabled**: disabled when example in not in contents |
| **<a id="doc.comment_examples_column" name="doc.comment_examples_column">doc.comment_examples_column</a>**<br/>[`integer`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` *`disabled`*<br/>**Command line**: --doc.comment_examples_column<br/>**Environment variable**: ROUGAILCLI_DOC.COMMENT_EXAMPLES_COLUMN | Comment in examples starts at column.<br/>**Default**: 30<br/>**Disabled**: when the variable "[Add description of variables and families when generate examples](#doc.comment_examples)" is accessible and has the value "false" |
| **<a id="doc.output_format" name="doc.output_format">doc.output_format</a>**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory`<br/>**Command line**: -do, --doc.output_format<br/>**Environment variable**: ROUGAILCLI_DOC.OUTPUT_FORMAT | Generate document in format.<br/>**Validator**: json output_format is not compatible with "changelog" and "example" contents<br/>**Choices**: <br/>•&nbsp;console **← (default)**<br/>•&nbsp;asciidoc<br/>•&nbsp;html<br/>•&nbsp;github<br/>•&nbsp;gitlab<br/>•&nbsp;json |
| **<a id="doc.table_model" name="doc.table_model">doc.table_model</a>**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory`<br/>**Command line**: -dm, --doc.table_model<br/>**Environment variable**: ROUGAILCLI_DOC.TABLE_MODEL | Generate document inside table model.<br/>**Validator**: json output_format is not compatible with "changelog" and "example" contents<br/>**Choices**: <br/>•&nbsp;two_columns **← (default)**<br/>•&nbsp;three_columns<br/>•&nbsp;four_columns<br/>•&nbsp;five_columns<br/>•&nbsp;six_columns |
| **<a id="doc.true_color_terminal" name="doc.true_color_terminal">doc.true_color_terminal</a>**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory`<br/>**Command line**: <br/>•&nbsp;--doc.true_color_terminal<br/>•&nbsp;--doc.no-true_color_terminal<br/>**Environment variable**: ROUGAILCLI_DOC.TRUE_COLOR_TERMINAL | Force true color terminal.<br/>**Default**: false |
## Families or variables for this family are in an other file name
> **🛈 Informations**
>
> **<a id="doc.other_root_filenames" name="doc.other_root_filenames">doc.other_root_filenames</a>**\
> This family contains lists of variable blocks.\
> `basic` *`disabled`*\
> **Disabled**: if "[Document the variables from this family](#doc.root)" haven't any value
| Variable | Description |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------|
| **<a id="doc.other_root_filenames.root_path" name="doc.other_root_filenames.root_path">doc.other_root_filenames.root_path</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` `standard` `unique`<br/>**Command line**: --doc.other_root_filenames.root_path<br/>**Environment variable**: ROUGAILCLI_DOC.OTHER_ROOT_FILENAMES.ROOT_PATH | Root family name. |
| **<a id="doc.other_root_filenames.filename" name="doc.other_root_filenames.filename">doc.other_root_filenames.filename</a>**<br/>[`UNIX filename`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory`<br/>**Command line**: --doc.other_root_filenames.filename<br/>**Environment variable**: ROUGAILCLI_DOC.OTHER_ROOT_FILENAMES.FILENAME | Name of the file.<br/>**Validators**: <br/>•&nbsp;this filename could be a relative path<br/>•&nbsp;file type allowed: "directory" and "file" |
# Three columns
## Generate documentation
> **🛈 Informations**
>
> **<a id="doc" name="doc">doc</a>**\
> `basic` *`disabled`*\
> **Disabled**: when "[Generate documentation](#doc)" is not set in "[Select for output](#step.output)"
| Variable | Description | Default value |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------|
| **<a id="doc.title_level" name="doc.title_level">doc.title_level</a>**<br/>[`integer`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory`<br/>**Command line**: -dt, --doc.title_level<br/>**Environment variable**: ROUGAILCLI_DOC.TITLE_LEVEL | Starting title level. | 1 |
| **<a id="doc.contents" name="doc.contents">doc.contents</a>**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` `standard` `mandatory` `unique`<br/>**Command line**: -dc, --doc.contents<br/>**Environment variable**: ROUGAILCLI_DOC.CONTENTS | Generated content.<br/>**Choices**: <br/>•&nbsp;variables<br/>•&nbsp;example<br/>•&nbsp;changelog | •&nbsp;variables |
| **<a id="doc.previous_json_file" name="doc.previous_json_file">doc.previous_json_file</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` *`disabled`*<br/>**Command line**: -dp, --doc.previous_json_file<br/>**Environment variable**: ROUGAILCLI_DOC.PREVIOUS_JSON_FILE | Previous description file in JSON format.<br/>**Disabled**: changelog is not selected in "[Generated content](#doc.contents)" | |
| **<a id="doc.without_family" name="doc.without_family">doc.without_family</a>**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` *`disabled`*<br/>**Command line**: <br/>•&nbsp;-df, --doc.without_family<br/>•&nbsp;-ndf, --doc.no-without_family<br/>**Environment variable**: ROUGAILCLI_DOC.WITHOUT_FAMILY | Do not add families in documentation.<br/>**Disabled**: if "[Generate document in format](#doc.output_format)" is json or "[Generated content](#doc.contents)" hasn't variable or changelog | false |
| **<a id="doc.root" name="doc.root">doc.root</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard`<br/>**Command line**: -dr, --doc.root<br/>**Environment variable**: ROUGAILCLI_DOC.ROOT | Document the variables from this family. | |
| **<a id="doc.with_commandline" name="doc.with_commandline">doc.with_commandline</a>**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` *`disabled`*<br/>**Command line**: <br/>•&nbsp;-dw, --doc.with_commandline<br/>•&nbsp;-ndw, --doc.no-with_commandline<br/>**Environment variable**: ROUGAILCLI_DOC.WITH_COMMANDLINE | Add command line informations in documentation.<br/>**Disabled**: if "[Generate document in format](#doc.output_format)" is json or "[Generated content](#doc.contents)" hasn't variable or changelog | false |
| **<a id="doc.with_environment" name="doc.with_environment">doc.with_environment</a>**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` *`disabled`*<br/>**Command line**: <br/>•&nbsp;-de, --doc.with_environment<br/>•&nbsp;-nde, --doc.no-with_environment<br/>**Environment variable**: ROUGAILCLI_DOC.WITH_ENVIRONMENT | Add environment variable informations in documentation.<br/>**Disabled**: if "[Generate document in format](#doc.output_format)" is json or "[Generated content](#doc.contents)" hasn't variable or changelog | false |
| **<a id="doc.environment_prefix" name="doc.environment_prefix">doc.environment_prefix</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` *`disabled`*<br/>**Command line**: -dd, --doc.environment_prefix<br/>**Environment variable**: ROUGAILCLI_DOC.ENVIRONMENT_PREFIX | Name of the default environment prefix.<br/>**Validator**: should only user uppercase characters<br/>**Disabled**: when "__.main_namespace" is not set or "[Add environment variable informations in documentation](#doc.with_environment)" is false | ROUGAIL |
| **<a id="doc.disabled_modes" name="doc.disabled_modes">doc.disabled_modes</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` `standard` *`disabled`* `unique`<br/>**Command line**: --doc.disabled_modes<br/>**Environment variable**: ROUGAILCLI_DOC.DISABLED_MODES | Disable documentation for variables with those modes.<br/>**Validator**: verify if disable modes already exists<br/>**Disabled**: disabled when there is no mode available | |
| **<a id="doc.change_default_value" name="doc.change_default_value">doc.change_default_value</a>**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory`<br/>**Command line**: <br/>•&nbsp;--doc.change_default_value<br/>•&nbsp;--doc.no-change_default_value<br/>**Environment variable**: ROUGAILCLI_DOC.CHANGE_DEFAULT_VALUE | Modify values to document leaderships and dynamics families. | true |
| **<a id="doc.comment_examples" name="doc.comment_examples">doc.comment_examples</a>**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` *`disabled`*<br/>**Command line**: <br/>•&nbsp;-dx, --doc.comment_examples<br/>•&nbsp;-ndx, --doc.no-comment_examples<br/>**Environment variable**: ROUGAILCLI_DOC.COMMENT_EXAMPLES | Add description of variables and families when generate examples.<br/>**Disabled**: disabled when example in not in contents | false |
| **<a id="doc.comment_examples_column" name="doc.comment_examples_column">doc.comment_examples_column</a>**<br/>[`integer`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` *`disabled`*<br/>**Command line**: --doc.comment_examples_column<br/>**Environment variable**: ROUGAILCLI_DOC.COMMENT_EXAMPLES_COLUMN | Comment in examples starts at column.<br/>**Disabled**: when the variable "[Add description of variables and families when generate examples](#doc.comment_examples)" is accessible and has the value "false" | 30 |
| **<a id="doc.output_format" name="doc.output_format">doc.output_format</a>**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory`<br/>**Command line**: -do, --doc.output_format<br/>**Environment variable**: ROUGAILCLI_DOC.OUTPUT_FORMAT | Generate document in format.<br/>**Validator**: json output_format is not compatible with "changelog" and "example" contents<br/>**Choices**: <br/>•&nbsp;console<br/>•&nbsp;asciidoc<br/>•&nbsp;html<br/>•&nbsp;github<br/>•&nbsp;gitlab<br/>•&nbsp;json | console |
| **<a id="doc.table_model" name="doc.table_model">doc.table_model</a>**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory`<br/>**Command line**: -dm, --doc.table_model<br/>**Environment variable**: ROUGAILCLI_DOC.TABLE_MODEL | Generate document inside table model.<br/>**Validator**: json output_format is not compatible with "changelog" and "example" contents<br/>**Choices**: <br/>•&nbsp;two_columns<br/>•&nbsp;three_columns<br/>•&nbsp;four_columns<br/>•&nbsp;five_columns<br/>•&nbsp;six_columns | two_columns |
| **<a id="doc.true_color_terminal" name="doc.true_color_terminal">doc.true_color_terminal</a>**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory`<br/>**Command line**: <br/>•&nbsp;--doc.true_color_terminal<br/>•&nbsp;--doc.no-true_color_terminal<br/>**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**
>
> **<a id="doc.other_root_filenames" name="doc.other_root_filenames">doc.other_root_filenames</a>**\
> This family contains lists of variable blocks.\
> `basic` *`disabled`*\
> **Disabled**: if "[Document the variables from this family](#doc.root)" haven't any value
| Variable | Description |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------|
| **<a id="doc.other_root_filenames.root_path" name="doc.other_root_filenames.root_path">doc.other_root_filenames.root_path</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` `standard` `unique`<br/>**Command line**: --doc.other_root_filenames.root_path<br/>**Environment variable**: ROUGAILCLI_DOC.OTHER_ROOT_FILENAMES.ROOT_PATH | Root family name. |
| **<a id="doc.other_root_filenames.filename" name="doc.other_root_filenames.filename">doc.other_root_filenames.filename</a>**<br/>[`UNIX filename`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory`<br/>**Command line**: --doc.other_root_filenames.filename<br/>**Environment variable**: ROUGAILCLI_DOC.OTHER_ROOT_FILENAMES.FILENAME | Name of the file.<br/>**Validators**: <br/>•&nbsp;this filename could be a relative path<br/>•&nbsp;file type allowed: "directory" and "file" |
# Four columns
## Generate documentation
feat: document commandline and environment variable
2025-11-27 22:17:17 +01:00
> **🛈 Informations**
>
> **<a id="doc" name="doc">doc</a>**\
> `basic` *`disabled`*\
> **Disabled**: when "[Generate documentation](#doc)" is not set in "[Select for output](#step.output)"
feat: personalise column number
2025-11-29 22:21:06 +01:00
| Variable | Description | Default value | Type |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------|-----------------------------------------------------------------------------------------------------------|
| **<a id="doc.title_level" name="doc.title_level">doc.title_level</a>**<br/>`standard`<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.contents" name="doc.contents">doc.contents</a>**<br/>`standard` `unique`<br/>**Command line**: -dc, --doc.contents<br/>**Environment variable**: ROUGAILCLI_DOC.CONTENTS | Generated content.<br/>**Choices**: <br/>•&nbsp;variables<br/>•&nbsp;example<br/>•&nbsp;changelog | •&nbsp;variables | [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` `mandatory` |
| **<a id="doc.previous_json_file" name="doc.previous_json_file">doc.previous_json_file</a>**<br/>`basic` *`disabled`*<br/>**Command line**: -dp, --doc.previous_json_file<br/>**Environment variable**: ROUGAILCLI_DOC.PREVIOUS_JSON_FILE | Previous description file in JSON format.<br/>**Disabled**: changelog is not selected in "[Generated content](#doc.contents)" | | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` |
| **<a id="doc.without_family" name="doc.without_family">doc.without_family</a>**<br/>`standard` *`disabled`*<br/>**Command line**: <br/>•&nbsp;-df, --doc.without_family<br/>•&nbsp;-ndf, --doc.no-without_family<br/>**Environment variable**: ROUGAILCLI_DOC.WITHOUT_FAMILY | Do not add families in documentation.<br/>**Disabled**: if "[Generate document in format](#doc.output_format)" is json or "[Generated content](#doc.contents)" hasn't variable or changelog | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` |
| **<a id="doc.root" name="doc.root">doc.root</a>**<br/>`standard`<br/>**Command line**: -dr, --doc.root<br/>**Environment variable**: ROUGAILCLI_DOC.ROOT | Document the variables from this family. | | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) |
| **<a id="doc.with_commandline" name="doc.with_commandline">doc.with_commandline</a>**<br/>`standard` *`disabled`*<br/>**Command line**: <br/>•&nbsp;-dw, --doc.with_commandline<br/>•&nbsp;-ndw, --doc.no-with_commandline<br/>**Environment variable**: ROUGAILCLI_DOC.WITH_COMMANDLINE | Add command line informations in documentation.<br/>**Disabled**: if "[Generate document in format](#doc.output_format)" is json or "[Generated content](#doc.contents)" hasn't variable or changelog | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` |
| **<a id="doc.with_environment" name="doc.with_environment">doc.with_environment</a>**<br/>`standard` *`disabled`*<br/>**Command line**: <br/>•&nbsp;-de, --doc.with_environment<br/>•&nbsp;-nde, --doc.no-with_environment<br/>**Environment variable**: ROUGAILCLI_DOC.WITH_ENVIRONMENT | Add environment variable informations in documentation.<br/>**Disabled**: if "[Generate document in format](#doc.output_format)" is json or "[Generated content](#doc.contents)" hasn't variable or changelog | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` |
| **<a id="doc.environment_prefix" name="doc.environment_prefix">doc.environment_prefix</a>**<br/>`standard` *`disabled`*<br/>**Command line**: -dd, --doc.environment_prefix<br/>**Environment variable**: ROUGAILCLI_DOC.ENVIRONMENT_PREFIX | Name of the default environment prefix.<br/>**Validator**: should only user uppercase characters<br/>**Disabled**: when "__.main_namespace" is not set or "[Add environment variable informations in documentation](#doc.with_environment)" is false | ROUGAIL | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` |
| **<a id="doc.disabled_modes" name="doc.disabled_modes">doc.disabled_modes</a>**<br/>`standard` *`disabled`* `unique`<br/>**Command line**: --doc.disabled_modes<br/>**Environment variable**: ROUGAILCLI_DOC.DISABLED_MODES | Disable documentation for variables with those modes.<br/>**Validator**: verify if disable modes already exists<br/>**Disabled**: disabled when there is no mode available | | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` |
| **<a id="doc.change_default_value" name="doc.change_default_value">doc.change_default_value</a>**<br/>`standard`<br/>**Command line**: <br/>•&nbsp;--doc.change_default_value<br/>•&nbsp;--doc.no-change_default_value<br/>**Environment variable**: ROUGAILCLI_DOC.CHANGE_DEFAULT_VALUE | Modify values to document leaderships and dynamics families. | true | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` |
| **<a id="doc.comment_examples" name="doc.comment_examples">doc.comment_examples</a>**<br/>`standard` *`disabled`*<br/>**Command line**: <br/>•&nbsp;-dx, --doc.comment_examples<br/>•&nbsp;-ndx, --doc.no-comment_examples<br/>**Environment variable**: ROUGAILCLI_DOC.COMMENT_EXAMPLES | Add description of variables and families when generate examples.<br/>**Disabled**: disabled when example in not in contents | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` |
| **<a id="doc.comment_examples_column" name="doc.comment_examples_column">doc.comment_examples_column</a>**<br/>`standard` *`disabled`*<br/>**Command line**: --doc.comment_examples_column<br/>**Environment variable**: ROUGAILCLI_DOC.COMMENT_EXAMPLES_COLUMN | Comment in examples starts at column.<br/>**Disabled**: when the variable "[Add description of variables and families when generate examples](#doc.comment_examples)" is accessible and has the value "false" | 30 | [`integer`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` |
| **<a id="doc.output_format" name="doc.output_format">doc.output_format</a>**<br/>`standard`<br/>**Command line**: -do, --doc.output_format<br/>**Environment variable**: ROUGAILCLI_DOC.OUTPUT_FORMAT | Generate document in format.<br/>**Validator**: json output_format is not compatible with "changelog" and "example" contents<br/>**Choices**: <br/>•&nbsp;console<br/>•&nbsp;asciidoc<br/>•&nbsp;html<br/>•&nbsp;github<br/>•&nbsp;gitlab<br/>•&nbsp;json | console | [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` |
| **<a id="doc.table_model" name="doc.table_model">doc.table_model</a>**<br/>`standard`<br/>**Command line**: -dm, --doc.table_model<br/>**Environment variable**: ROUGAILCLI_DOC.TABLE_MODEL | Generate document inside table model.<br/>**Validator**: json output_format is not compatible with "changelog" and "example" contents<br/>**Choices**: <br/>•&nbsp;two_columns<br/>•&nbsp;three_columns<br/>•&nbsp;four_columns<br/>•&nbsp;five_columns<br/>•&nbsp;six_columns | two_columns | [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` |
| **<a id="doc.true_color_terminal" name="doc.true_color_terminal">doc.true_color_terminal</a>**<br/>`standard`<br/>**Command line**: <br/>•&nbsp;--doc.true_color_terminal<br/>•&nbsp;--doc.no-true_color_terminal<br/>**Environment variable**: ROUGAILCLI_DOC.TRUE_COLOR_TERMINAL | Force true color terminal. | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` |
feat: document commandline and environment variable
2025-11-27 22:17:17 +01:00
feat: personalise column number
2025-11-29 22:21:06 +01:00
## Families or variables for this family are in an other file name
feat: document commandline and environment variable
2025-11-27 22:17:17 +01:00
> **🛈 Informations**
>
> **<a id="doc.other_root_filenames" name="doc.other_root_filenames">doc.other_root_filenames</a>**\
> This family contains lists of variable blocks.\
> `basic` *`disabled`*\
feat: personalise column number
2025-11-29 22:21:06 +01:00
> **Disabled**: if "[Document the variables from this family](#doc.root)" haven't any value
| Variable | Description | Type |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------|
| **<a id="doc.other_root_filenames.root_path" name="doc.other_root_filenames.root_path">doc.other_root_filenames.root_path</a>**<br/>`standard` `unique`<br/>**Command line**: --doc.other_root_filenames.root_path<br/>**Environment variable**: ROUGAILCLI_DOC.OTHER_ROOT_FILENAMES.ROOT_PATH | Root family name. | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` |
| **<a id="doc.other_root_filenames.filename" name="doc.other_root_filenames.filename">doc.other_root_filenames.filename</a>**<br/>`basic`<br/>**Command line**: --doc.other_root_filenames.filename<br/>**Environment variable**: ROUGAILCLI_DOC.OTHER_ROOT_FILENAMES.FILENAME | Name of the file.<br/>**Validators**: <br/>•&nbsp;this filename could be a relative path<br/>•&nbsp;file type allowed: "directory" and "file" | [`UNIX filename`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` |
# Five columns
## Generate documentation
> **🛈 Informations**
>
> **<a id="doc" name="doc">doc</a>**\
> `basic` *`disabled`*\
> **Disabled**: when "[Generate documentation](#doc)" is not set in "[Select for output](#step.output)"
| Variable | Description | Default value | Type | Access control |
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------|-----------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **<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` | `standard` |
| **<a id="doc.contents" name="doc.contents">doc.contents</a>**<br/>`unique`<br/>**Command line**: -dc, --doc.contents<br/>**Environment variable**: ROUGAILCLI_DOC.CONTENTS | Generated content.<br/>**Choices**: <br/>•&nbsp;variables<br/>•&nbsp;example<br/>•&nbsp;changelog | •&nbsp;variables | [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` `mandatory` | `standard` |
| **<a id="doc.previous_json_file" name="doc.previous_json_file">doc.previous_json_file</a>**<br/>**Command line**: -dp, --doc.previous_json_file<br/>**Environment variable**: ROUGAILCLI_DOC.PREVIOUS_JSON_FILE | Previous description file in JSON format. | | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | `basic` *`disabled`*<br/>**Disabled**: changelog is not selected in "[Generated content](#doc.contents)" |
| **<a id="doc.without_family" name="doc.without_family">doc.without_family</a>**<br/>**Command line**: <br/>•&nbsp;-df, --doc.without_family<br/>•&nbsp;-ndf, --doc.no-without_family<br/>**Environment variable**: ROUGAILCLI_DOC.WITHOUT_FAMILY | Do not add families in documentation. | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | `standard` *`disabled`*<br/>**Disabled**: if "[Generate document in format](#doc.output_format)" is json or "[Generated content](#doc.contents)" hasn't variable or changelog |
| **<a id="doc.root" name="doc.root">doc.root</a>**<br/>**Command line**: -dr, --doc.root<br/>**Environment variable**: ROUGAILCLI_DOC.ROOT | Document the variables from this family. | | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) | `standard` |
| **<a id="doc.with_commandline" name="doc.with_commandline">doc.with_commandline</a>**<br/>**Command line**: <br/>•&nbsp;-dw, --doc.with_commandline<br/>•&nbsp;-ndw, --doc.no-with_commandline<br/>**Environment variable**: ROUGAILCLI_DOC.WITH_COMMANDLINE | Add command line informations in documentation. | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | `standard` *`disabled`*<br/>**Disabled**: if "[Generate document in format](#doc.output_format)" is json or "[Generated content](#doc.contents)" hasn't variable or changelog |
| **<a id="doc.with_environment" name="doc.with_environment">doc.with_environment</a>**<br/>**Command line**: <br/>•&nbsp;-de, --doc.with_environment<br/>•&nbsp;-nde, --doc.no-with_environment<br/>**Environment variable**: ROUGAILCLI_DOC.WITH_ENVIRONMENT | Add environment variable informations in documentation. | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | `standard` *`disabled`*<br/>**Disabled**: if "[Generate document in format](#doc.output_format)" is json or "[Generated content](#doc.contents)" hasn't variable or changelog |
| **<a id="doc.environment_prefix" name="doc.environment_prefix">doc.environment_prefix</a>**<br/>**Command line**: -dd, --doc.environment_prefix<br/>**Environment variable**: ROUGAILCLI_DOC.ENVIRONMENT_PREFIX | Name of the default environment prefix.<br/>**Validator**: should only user uppercase characters | ROUGAIL | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | `standard` *`disabled`*<br/>**Disabled**: when "__.main_namespace" is not set or "[Add environment variable informations in documentation](#doc.with_environment)" is false |
| **<a id="doc.disabled_modes" name="doc.disabled_modes">doc.disabled_modes</a>**<br/>`unique`<br/>**Command line**: --doc.disabled_modes<br/>**Environment variable**: ROUGAILCLI_DOC.DISABLED_MODES | Disable documentation for variables with those modes.<br/>**Validator**: verify if disable modes already exists | | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` | `standard` *`disabled`*<br/>**Disabled**: disabled when there is no mode available |
| **<a id="doc.change_default_value" name="doc.change_default_value">doc.change_default_value</a>**<br/>**Command line**: <br/>•&nbsp;--doc.change_default_value<br/>•&nbsp;--doc.no-change_default_value<br/>**Environment variable**: ROUGAILCLI_DOC.CHANGE_DEFAULT_VALUE | Modify values to document leaderships and dynamics families. | true | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | `standard` |
| **<a id="doc.comment_examples" name="doc.comment_examples">doc.comment_examples</a>**<br/>**Command line**: <br/>•&nbsp;-dx, --doc.comment_examples<br/>•&nbsp;-ndx, --doc.no-comment_examples<br/>**Environment variable**: ROUGAILCLI_DOC.COMMENT_EXAMPLES | Add description of variables and families when generate examples. | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | `standard` *`disabled`*<br/>**Disabled**: disabled when example in not in contents |
| **<a id="doc.comment_examples_column" name="doc.comment_examples_column">doc.comment_examples_column</a>**<br/>**Command line**: --doc.comment_examples_column<br/>**Environment variable**: ROUGAILCLI_DOC.COMMENT_EXAMPLES_COLUMN | Comment in examples starts at column. | 30 | [`integer`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | `standard` *`disabled`*<br/>**Disabled**: when the variable "[Add description of variables and families when generate examples](#doc.comment_examples)" is accessible and has the value "false" |
| **<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 | Generate document in format.<br/>**Validator**: json output_format is not compatible with "changelog" and "example" contents<br/>**Choices**: <br/>•&nbsp;console<br/>•&nbsp;asciidoc<br/>•&nbsp;html<br/>•&nbsp;github<br/>•&nbsp;gitlab<br/>•&nbsp;json | console | [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | `standard` |
| **<a id="doc.table_model" name="doc.table_model">doc.table_model</a>**<br/>**Command line**: -dm, --doc.table_model<br/>**Environment variable**: ROUGAILCLI_DOC.TABLE_MODEL | Generate document inside table model.<br/>**Validator**: json output_format is not compatible with "changelog" and "example" contents<br/>**Choices**: <br/>•&nbsp;two_columns<br/>•&nbsp;three_columns<br/>•&nbsp;four_columns<br/>•&nbsp;five_columns<br/>•&nbsp;six_columns | two_columns | [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | `standard` |
| **<a id="doc.true_color_terminal" name="doc.true_color_terminal">doc.true_color_terminal</a>**<br/>**Command line**: <br/>•&nbsp;--doc.true_color_terminal<br/>•&nbsp;--doc.no-true_color_terminal<br/>**Environment variable**: ROUGAILCLI_DOC.TRUE_COLOR_TERMINAL | Force true color terminal. | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | `standard` |
## Families or variables for this family are in an other file name
> **🛈 Informations**
>
> **<a id="doc.other_root_filenames" name="doc.other_root_filenames">doc.other_root_filenames</a>**\
> This family contains lists of variable blocks.\
> `basic` *`disabled`*\
> **Disabled**: if "[Document the variables from this family](#doc.root)" haven't any value
| Variable | Description | Type | Access control |
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------|------------------|
| **<a id="doc.other_root_filenames.root_path" name="doc.other_root_filenames.root_path">doc.other_root_filenames.root_path</a>**<br/>`unique`<br/>**Command line**: --doc.other_root_filenames.root_path<br/>**Environment variable**: ROUGAILCLI_DOC.OTHER_ROOT_FILENAMES.ROOT_PATH | Root family name. | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` | `standard` |
| **<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.<br/>**Validators**: <br/>•&nbsp;this filename could be a relative path<br/>•&nbsp;file type allowed: "directory" and "file" | [`UNIX filename`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | `basic` |
# Six columns
## Generate documentation
> **🛈 Informations**
>
> **<a id="doc" name="doc">doc</a>**\
> `basic` *`disabled`*\
> **Disabled**: when "[Generate documentation](#doc)" is not set in "[Select for output](#step.output)"
| Variable | Description | Default value | Type | Access control | Validator |
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------|-----------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------|
| **<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` | `standard` | |
| **<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/>**Choices**: <br/>•&nbsp;variables<br/>•&nbsp;example<br/>•&nbsp;changelog | •&nbsp;variables | [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` `mandatory` | `standard` | `unique` |
| **<a id="doc.previous_json_file" name="doc.previous_json_file">doc.previous_json_file</a>**<br/>**Command line**: -dp, --doc.previous_json_file<br/>**Environment variable**: ROUGAILCLI_DOC.PREVIOUS_JSON_FILE | Previous description file in JSON format. | | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | `basic` *`disabled`*<br/>**Disabled**: changelog is not selected in "[Generated content](#doc.contents)" | |
| **<a id="doc.without_family" name="doc.without_family">doc.without_family</a>**<br/>**Command line**: <br/>•&nbsp;-df, --doc.without_family<br/>•&nbsp;-ndf, --doc.no-without_family<br/>**Environment variable**: ROUGAILCLI_DOC.WITHOUT_FAMILY | Do not add families in documentation. | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | `standard` *`disabled`*<br/>**Disabled**: if "[Generate document in format](#doc.output_format)" is json or "[Generated content](#doc.contents)" hasn't variable or changelog | |
| **<a id="doc.root" name="doc.root">doc.root</a>**<br/>**Command line**: -dr, --doc.root<br/>**Environment variable**: ROUGAILCLI_DOC.ROOT | Document the variables from this family. | | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) | `standard` | |
| **<a id="doc.with_commandline" name="doc.with_commandline">doc.with_commandline</a>**<br/>**Command line**: <br/>•&nbsp;-dw, --doc.with_commandline<br/>•&nbsp;-ndw, --doc.no-with_commandline<br/>**Environment variable**: ROUGAILCLI_DOC.WITH_COMMANDLINE | Add command line informations in documentation. | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | `standard` *`disabled`*<br/>**Disabled**: if "[Generate document in format](#doc.output_format)" is json or "[Generated content](#doc.contents)" hasn't variable or changelog | |
| **<a id="doc.with_environment" name="doc.with_environment">doc.with_environment</a>**<br/>**Command line**: <br/>•&nbsp;-de, --doc.with_environment<br/>•&nbsp;-nde, --doc.no-with_environment<br/>**Environment variable**: ROUGAILCLI_DOC.WITH_ENVIRONMENT | Add environment variable informations in documentation. | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | `standard` *`disabled`*<br/>**Disabled**: if "[Generate document in format](#doc.output_format)" is json or "[Generated content](#doc.contents)" hasn't variable or changelog | |
| **<a id="doc.environment_prefix" name="doc.environment_prefix">doc.environment_prefix</a>**<br/>**Command line**: -dd, --doc.environment_prefix<br/>**Environment variable**: ROUGAILCLI_DOC.ENVIRONMENT_PREFIX | Name of the default environment prefix. | ROUGAIL | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | `standard` *`disabled`*<br/>**Disabled**: when "__.main_namespace" is not set or "[Add environment variable informations in documentation](#doc.with_environment)" is false | Should only user uppercase characters. |
| **<a id="doc.disabled_modes" name="doc.disabled_modes">doc.disabled_modes</a>**<br/>**Command line**: --doc.disabled_modes<br/>**Environment variable**: ROUGAILCLI_DOC.DISABLED_MODES | Disable documentation for variables with those modes. | | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` | `standard` *`disabled`*<br/>**Disabled**: disabled when there is no mode available | `unique`<br/>Verify if disable modes already exists. |
| **<a id="doc.change_default_value" name="doc.change_default_value">doc.change_default_value</a>**<br/>**Command line**: <br/>•&nbsp;--doc.change_default_value<br/>•&nbsp;--doc.no-change_default_value<br/>**Environment variable**: ROUGAILCLI_DOC.CHANGE_DEFAULT_VALUE | Modify values to document leaderships and dynamics families. | true | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | `standard` | |
| **<a id="doc.comment_examples" name="doc.comment_examples">doc.comment_examples</a>**<br/>**Command line**: <br/>•&nbsp;-dx, --doc.comment_examples<br/>•&nbsp;-ndx, --doc.no-comment_examples<br/>**Environment variable**: ROUGAILCLI_DOC.COMMENT_EXAMPLES | Add description of variables and families when generate examples. | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | `standard` *`disabled`*<br/>**Disabled**: disabled when example in not in contents | |
| **<a id="doc.comment_examples_column" name="doc.comment_examples_column">doc.comment_examples_column</a>**<br/>**Command line**: --doc.comment_examples_column<br/>**Environment variable**: ROUGAILCLI_DOC.COMMENT_EXAMPLES_COLUMN | Comment in examples starts at column. | 30 | [`integer`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | `standard` *`disabled`*<br/>**Disabled**: when the variable "[Add description of variables and families when generate examples](#doc.comment_examples)" is accessible and has the value "false" | |
| **<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 | Generate document in format.<br/>**Choices**: <br/>•&nbsp;console<br/>•&nbsp;asciidoc<br/>•&nbsp;html<br/>•&nbsp;github<br/>•&nbsp;gitlab<br/>•&nbsp;json | console | [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | `standard` | Json output_format is not compatible with "changelog" and "example" contents. |
| **<a id="doc.table_model" name="doc.table_model">doc.table_model</a>**<br/>**Command line**: -dm, --doc.table_model<br/>**Environment variable**: ROUGAILCLI_DOC.TABLE_MODEL | Generate document inside table model.<br/>**Choices**: <br/>•&nbsp;two_columns<br/>•&nbsp;three_columns<br/>•&nbsp;four_columns<br/>•&nbsp;five_columns<br/>•&nbsp;six_columns | two_columns | [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | `standard` | Json output_format is not compatible with "changelog" and "example" contents. |
| **<a id="doc.true_color_terminal" name="doc.true_color_terminal">doc.true_color_terminal</a>**<br/>**Command line**: <br/>•&nbsp;--doc.true_color_terminal<br/>•&nbsp;--doc.no-true_color_terminal<br/>**Environment variable**: ROUGAILCLI_DOC.TRUE_COLOR_TERMINAL | Force true color terminal. | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | `standard` | |
## Families or variables for this family are in an other file name
> **🛈 Informations**
>
> **<a id="doc.other_root_filenames" name="doc.other_root_filenames">doc.other_root_filenames</a>**\
> This family contains lists of variable blocks.\
> `basic` *`disabled`*\
> **Disabled**: if "[Document the variables from this family](#doc.root)" haven't any value
| Variable | Description | Type | Access control | 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 | Root family name. | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` | `standard` | `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` | `basic` | •&nbsp;this filename could be a relative path<br/>•&nbsp;file type allowed: "directory" and "file". |
feat: document commandline and environment variable
2025-11-27 22:17:17 +01:00
Initial commit
2024-07-10 21:23:57 +02:00
Reference in a new issue Copy permalink