gitea: none include_toc: true
Generate documentation from structural files
[!NOTE]
The structural files contain all the information related to the variables. This output generates the documentation for all or some of these variables.
Path: doc
disabled
Disabled: if "select for output" is not doc.
| Variable | Description | Default value | Type | Access control | Validator |
|---|---|---|---|---|---|
| doc.output_format Command line: -do, --doc.output_format Environment variable: DOC.OUTPUT_FORMAT |
The output format of the generated documentation. | console | choice mandatory |
Choices: • console • asciidoc • html • github • gitlab • json |
|
| doc.tabular_template Command line: -dm, --doc.tabular_template Environment variable: DOC.TABULAR_TEMPLATE |
Generate document with this tabular model. The variables are documented with a tabular view. A template selection allows you to choose the content of each column. |
two_columns | choice mandatory |
disabledDisabled: "the output format of the generated documentation" in json is not compatible with this variable. |
Choices: • two_columns • three_columns • four_columns • five_columns • six_columns |
| doc.contents Command line: -dc, --doc.contents Environment variable: 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"). |
• variables | choice multiple mandatory |
hiddenHidden: "the output format of the generated documentation" in json is not compatible with changelog or example "generated content". |
uniqueChoices: • variables • example • changelog |
| doc.title_level Command line: -dt, --doc.title_level Environment variable: DOC.TITLE_LEVEL |
Starting title level. | 1 | integer mandatory |
||
| doc.default_values Command line: • --doc.default_values • --doc.no-default_values Environment variable: 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: DOC.TRUE_COLOR |
Display documentation in console always with true color terminal. | false | boolean mandatory |
disabledDisabled: when the variable "the output format of the generated documentation" hasn't the value "console". |
The variables in this family are documented in another file
[!NOTE]
If you separate the variables into different files, the links between the variables will break. Therefore, you must define different filenames for the files containing these variables.
This family contains lists of variable blocks.
Path: doc.other_root_filenames
| Variable | Description | Type | Validator |
|---|---|---|---|
| doc.other_root_filenames.root_path Command line: --doc.other_root_filenames.root_path Environment variable: DOC.OTHER_ROOT_FILENAMES.ROOT_PATH |
This file contains child variables of the family. | string multiple |
unique |
| doc.other_root_filenames.root_doc_path Command line: --doc.other_root_filenames.root_doc_path Environment variable: DOC.OTHER_ROOT_FILENAMES.ROOT_DOC_PATH |
Name of the file. | string |
| Variable | Description | Default value | Type |
|---|---|---|---|
| doc.document_a_type Command line: • --doc.document_a_type • --doc.no-document_a_type Environment variable: DOC.DOCUMENT_A_TYPE |
Documentation a structural type. | false | boolean mandatory |
Variables and changelog documentation
[!NOTE]
Path: doc.tabulars
disabled
Disabled: if "the output format of the generated documentation" is json or "generated content" hasn't variables or changelog.
| Variable | Description | Default value | Type | Access control | Validator |
|---|---|---|---|---|---|
| doc.tabulars.without_family Command line: • -df, --doc.tabulars.without_family • -ndf, --doc.tabulars.no-without_family Environment variable: DOC.TABULARS.WITHOUT_FAMILY |
Do not add families in documentation. | false | boolean mandatory |
||
| doc.tabulars.with_commandline Environment variable: DOC.TABULARS.WITH_COMMANDLINE |
Add command line informations in documentation. | false | boolean mandatory |
||
| doc.tabulars.with_environment Command line: • -de, --doc.tabulars.with_environment • -nde, --doc.tabulars.no-with_environment Environment variable: DOC.TABULARS.WITH_ENVIRONMENT |
Add environment variable informations in documentation. | false | boolean mandatory |
||
| doc.tabulars.environment_prefix Command line: -dv, --doc.tabulars.environment_prefix Environment variable: DOC.TABULARS.ENVIRONMENT_PREFIX |
Environment variables prefix name. | ROUGAIL | string mandatory |
disabledDisabled: if "main_namespace" is not set or "add environment variable informations in documentation" is false. |
Should only use uppercase characters. |
Changelog documentation
[!NOTE]
Path: 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: 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
[!NOTE]
Path: doc.examples
disabled
Disabled: if example is 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: 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: DOC.EXAMPLES.COMMENT_COLUMN |
Comment in examples starts at column. | 30 | integer mandatory |
disabledDisabled: when the variable "add description of variables and families when generate examples" has the value "false". |
1 maintainer
Metadata
1 maintainer
Release files for rougail.output_doc 1.0.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| rougail_output_doc-1.0.3.tar.gz | 1.3 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| rougail_output_doc-1.0.3-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 1.4 MB
Release files / rougail_output_doc-1.0.3.tar.gz
| Download URL | rougail_output_doc-1.0.3.tar.gz |
|---|---|
| Size | 1.3 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
4834a4ce872a4f6ab18b783947d54783e646be0a9bc5793d473b2f557712ac03
|
|
BLAKE2b-256 checksum How to use checksums |
a77e161c5a8e8c28b22e769b4136f607b64b2910e47b2454a6b97f95761b84ec
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
python-requests/2.32.5
|
Release files / rougail_output_doc-1.0.3-py3-none-any.whl
| Download URL | rougail_output_doc-1.0.3-py3-none-any.whl |
|---|---|
| Size | 58.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
5c6d1e8dbb1a6b58d327959606b2b722534dcbcb8c4430cde09d5c7c06c2959a
|
|
BLAKE2b-256 checksum How to use checksums |
47043742106da2961e8f5730cc7b8a1264ab285189b9f88aa5ccc5c5556a5452
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
python-requests/2.32.5
|
