rougail-output-doc/README.md

Generate documentation

🛈 Informations

doc
basic disabled
Disabled: when "Generate documentation" is not set in "Select for output"

Variable	Description
doc.title_level integer standard mandatory Command line: --doc.title_level, -dt Environment variable: ROUGAILCLI_DOC.TITLE_LEVEL	Starting title level. Default: 1
doc.contents choice standard mandatory unique multiple Command line: --doc.contents Environment variable: ROUGAILCLI_DOC.CONTENTS	Generated content. Choices: • variables ← (default) • example • changelog
doc.previous_json_file string basic mandatory disabled Command line: --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_family boolean standard mandatory disabled Command line: • --doc.without_family • --doc.no-without_family Environment variable: ROUGAILCLI_DOC.WITHOUT_FAMILY	Do not add families in documentation. Default: false Disabled: variables is not selected in "Generated content"
doc.root string standard Command line: --doc.root Environment variable: ROUGAILCLI_DOC.ROOT	Document the variables from this family.
doc.with_commandline boolean standard mandatory disabled Command line: • --doc.with_commandline • --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 variables is not selected in "Generated content"
doc.with_environment boolean standard mandatory disabled Command line: • --doc.with_environment • --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 variables is not selected in "Generated content"
doc.environment_default_environment_name string standard mandatory disabled Command line: --doc.environment_default_environment_name Environment variable: ROUGAILCLI_DOC.ENVIRONMENT_DEFAULT_ENVIRONMENT_NAME	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

Families or variables for this family are in an other file name

🛈 Informations

doc.other_root_filenames
This family contains lists of variable blocks.
basic disabled
Disabled: documentation must be splitted

Variable	Description
doc.other_root_filenames.root_path string standard unique multiple Command line: --doc.other_root_filenames.root_path Environment variable: ROUGAILCLI_DOC.OTHER_ROOT_FILENAMES.ROOT_PATH	Root family name.
doc.other_root_filenames.filename unix_filename basic 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: "directory" and "file"

Variable	Description
doc.disabled_modes string standard disabled unique multiple Command 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.change_default_value boolean standard mandatory Command line: • --doc.change_default_value • --doc.no-change_default_value Environment variable: ROUGAILCLI_DOC.CHANGE_DEFAULT_VALUE	Modify values to document leaderships and dynamics families. Default: true
doc.comment_examples boolean standard mandatory disabled Command line: • --doc.comment_examples • --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_column integer standard mandatory disabled Command 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_format choice standard mandatory Command line: --doc.output_format, -do 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.force_true_color_terminal boolean standard mandatory Command line: • --doc.force_true_color_terminal • --doc.no-force_true_color_terminal Environment variable: ROUGAILCLI_DOC.FORCE_TRUE_COLOR_TERMINAL	Force true color terminal. Default: false