Compare commits
No commits in common. "main" and "1.0.0rc1" have entirely different histories.
5161 changed files with 5730 additions and 6275 deletions
413
CHANGELOG.md
413
CHANGELOG.md
|
|
@ -1,78 +1,46 @@
|
|||
## 1.0.3 (2026-06-28)
|
||||
|
||||
### Fix
|
||||
|
||||
- help line with only a space in family description
|
||||
|
||||
## 1.0.2 (2026-06-27)
|
||||
|
||||
### Fix
|
||||
|
||||
- hidden family in dynamic family with a sub root
|
||||
|
||||
## 1.0.1 (2026-06-21)
|
||||
|
||||
### Fix
|
||||
|
||||
- dependencies
|
||||
|
||||
## 1.0.0 (2026-06-21)
|
||||
## 1.0.0rc1 (2026-06-21)
|
||||
|
||||
### Feat
|
||||
|
||||
- better ansible documentation
|
||||
- leadership => sequence
|
||||
- add dot if needed
|
||||
- better documentation generation
|
||||
- support transitive
|
||||
- doc transitive properties
|
||||
- add 'document_a_type' option
|
||||
- remove doc.root, pass directly the family to doc output (be careful, add true_config parameter too)
|
||||
- personalise column number
|
||||
- document commandline and environment variable
|
||||
- change path in description
|
||||
- add anchor to markdown format and remove unsupported character in anchor id
|
||||
- use blockquote for family description
|
||||
- better enter support
|
||||
- delete/underline is inside tag for some format
|
||||
- can reload formatter
|
||||
- can document part by part with reloading structure
|
||||
- anchor in gitlab output_format
|
||||
- can had comments with family/variable description in examples doc
|
||||
- comment variables from a family
|
||||
- tags documentation
|
||||
- ca force true_color terminal when export to console
|
||||
- can document a variable for a specified identifier
|
||||
- can remove header when generate a table
|
||||
- add html output
|
||||
- changelog for variables
|
||||
- limit warning when asked
|
||||
- better support variable calculation for property
|
||||
- add gitlab plugin
|
||||
- default value for a calculated variable with an unknown optional variable
|
||||
- add integer type which will replace number type
|
||||
- adapt to tiramisu-web-ui
|
||||
- could not change default value during annotator
|
||||
- document unix file name parameters
|
||||
- better console output
|
||||
- do not document reference to undocumented variable
|
||||
- add with_family parameter
|
||||
- output return status too
|
||||
- create tests
|
||||
- personalize mode that we want disable documentation
|
||||
- add console output
|
||||
- better dynamique family support
|
||||
- add json output
|
||||
|
||||
## 0.2.0a51 (2026-06-15)
|
||||
|
||||
### Fix
|
||||
|
||||
- rougail dependencies
|
||||
- black
|
||||
- tests
|
||||
- update tests
|
||||
|
||||
## 0.2.0a50 (2026-06-11)
|
||||
|
||||
### Feat
|
||||
|
||||
- leadership => sequence
|
||||
|
||||
### Fix
|
||||
|
||||
- test example with mode
|
||||
|
||||
## 0.2.0a49 (2026-05-06)
|
||||
|
||||
### Fix
|
||||
|
||||
- example for partial documentation
|
||||
|
||||
## 0.2.0a48 (2026-05-04)
|
||||
|
||||
### Fix
|
||||
|
||||
- get unrestraint default value
|
||||
|
||||
## 0.2.0a47 (2026-04-30)
|
||||
|
||||
### Feat
|
||||
|
||||
- add dot if needed
|
||||
- better documentation generation
|
||||
|
||||
### Fix
|
||||
|
||||
- better identifier documentation
|
||||
- better display of path
|
||||
- better description informations
|
||||
|
|
@ -80,76 +48,383 @@
|
|||
- better identifier support
|
||||
- support mode
|
||||
- root config with identifier
|
||||
|
||||
## 0.2.0a46 (2026-01-29)
|
||||
|
||||
### Feat
|
||||
|
||||
- support transitive
|
||||
|
||||
### Fix
|
||||
|
||||
- better transitive documentation
|
||||
- update translation
|
||||
|
||||
## 0.2.0a45 (2026-01-21)
|
||||
|
||||
### Feat
|
||||
|
||||
- doc transitive properties
|
||||
|
||||
### Fix
|
||||
|
||||
- root could be a variable
|
||||
- path
|
||||
|
||||
## 0.2.0a44 (2026-01-14)
|
||||
|
||||
### Fix
|
||||
|
||||
- yaml in output format do not convert object to str
|
||||
|
||||
## 0.2.0a43 (2026-01-14)
|
||||
|
||||
### Feat
|
||||
|
||||
- add 'document_a_type' option
|
||||
|
||||
## 0.2.0a42 (2026-01-04)
|
||||
|
||||
### Feat
|
||||
|
||||
- remove doc.root, pass directly the family to doc output (be careful, add true_config parameter too)
|
||||
|
||||
## 0.2.0a41 (2025-12-30)
|
||||
|
||||
### Fix
|
||||
|
||||
- update tests
|
||||
- read_write is a boolean
|
||||
|
||||
## 0.2.0a40 (2025-12-22)
|
||||
|
||||
### Feat
|
||||
|
||||
- personalise column number
|
||||
- document commandline and environment variable
|
||||
|
||||
### Fix
|
||||
|
||||
- better documentation
|
||||
- better commandline doc + params description is now in rougail
|
||||
|
||||
## 0.2.0a39 (2025-11-21)
|
||||
|
||||
### Feat
|
||||
|
||||
- change path in description
|
||||
- add anchor to markdown format and remove unsupported character in anchor id
|
||||
- use blockquote for family description
|
||||
|
||||
### Fix
|
||||
|
||||
- dynamic variables with identifier in description
|
||||
- gitlab id in anchor with dynamic variables
|
||||
|
||||
## 0.2.0a38 (2025-11-10)
|
||||
|
||||
### Feat
|
||||
|
||||
- better enter support
|
||||
|
||||
## 0.2.0a37 (2025-11-06)
|
||||
|
||||
### Feat
|
||||
|
||||
- delete/underline is inside tag for some format
|
||||
- can reload formatter
|
||||
- can document part by part with reloading structure
|
||||
|
||||
## 0.2.0a36 (2025-10-29)
|
||||
|
||||
### Feat
|
||||
|
||||
- anchor in gitlab output_format
|
||||
- can had comments with family/variable description in examples doc
|
||||
- comment variables from a family
|
||||
|
||||
## 0.2.0a35 (2025-10-27)
|
||||
|
||||
### Feat
|
||||
|
||||
- tags documentation
|
||||
|
||||
### Fix
|
||||
|
||||
- add changelog support for github/gitlab format
|
||||
- tests
|
||||
|
||||
## 0.2.0a34 (2025-10-22)
|
||||
|
||||
### Feat
|
||||
|
||||
- ca force true_color terminal when export to console
|
||||
|
||||
### Fix
|
||||
|
||||
- parse subtree for a dynamic
|
||||
- adapt api for rougail-web-ui
|
||||
- undocumented variable in dynamic
|
||||
|
||||
## 0.2.0a33 (2025-10-16)
|
||||
|
||||
### Feat
|
||||
|
||||
- can document a variable for a specified identifier
|
||||
- can remove header when generate a table
|
||||
- add html output
|
||||
- changelog for variables
|
||||
|
||||
### Fix
|
||||
|
||||
- support rougail-web-ui
|
||||
- black
|
||||
- remove extra '*'
|
||||
- always use name for informations key (sometime path was used)
|
||||
- update tests
|
||||
- translation for property is now in rougail
|
||||
|
||||
## 0.2.0a32 (2025-10-03)
|
||||
|
||||
### Fix
|
||||
|
||||
- property calculated with disabled variable
|
||||
- better disabled support
|
||||
|
||||
## 0.2.0a31 (2025-10-02)
|
||||
|
||||
### Feat
|
||||
|
||||
- limit warning when asked
|
||||
|
||||
## 0.2.0a30 (2025-10-02)
|
||||
|
||||
### Feat
|
||||
|
||||
- better support variable calculation for property
|
||||
|
||||
## 0.2.0a29 (2025-10-02)
|
||||
|
||||
### Fix
|
||||
|
||||
- property for namespace
|
||||
|
||||
## 0.2.0a28 (2025-10-02)
|
||||
|
||||
### Feat
|
||||
|
||||
- add gitlab plugin
|
||||
|
||||
### Fix
|
||||
|
||||
- tests for formatter
|
||||
- update translation
|
||||
|
||||
## 0.2.0a27 (2025-09-29)
|
||||
|
||||
### Fix
|
||||
|
||||
- doc network with CIDR format
|
||||
- better doc for calculation with unknown variable
|
||||
|
||||
## 0.2.0a26 (2025-09-29)
|
||||
|
||||
### Feat
|
||||
|
||||
- default value for a calculated variable with an unknown optional variable
|
||||
- add integer type which will replace number type
|
||||
|
||||
## 0.2.0a25 (2025-09-22)
|
||||
|
||||
### Feat
|
||||
|
||||
- adapt to tiramisu-web-ui
|
||||
|
||||
## 0.2.0a24 (2025-06-19)
|
||||
|
||||
### Feat
|
||||
|
||||
- could not change default value during annotator
|
||||
|
||||
## 0.2.0a23 (2025-06-18)
|
||||
|
||||
### Fix
|
||||
|
||||
- separation
|
||||
|
||||
## 0.2.0a22 (2025-06-18)
|
||||
|
||||
### Fix
|
||||
|
||||
- rougail separation
|
||||
|
||||
## 0.2.0a21 (2025-05-12)
|
||||
|
||||
### Fix
|
||||
|
||||
- update translation
|
||||
- black
|
||||
- doc example with leader example lower than leader default value
|
||||
|
||||
## 0.2.0a20 (2025-05-09)
|
||||
|
||||
### Fix
|
||||
|
||||
- undefined is a rougail object
|
||||
|
||||
## 0.2.0a19 (2025-05-05)
|
||||
|
||||
### Fix
|
||||
|
||||
- update translation
|
||||
|
||||
## 0.2.0a18 (2025-05-05)
|
||||
|
||||
### Fix
|
||||
|
||||
- doc default value with undocumented variable
|
||||
|
||||
## 0.2.0a17 (2025-05-05)
|
||||
|
||||
### Fix
|
||||
|
||||
- description for all calculations
|
||||
- better documentation variable with variable in default attribut
|
||||
|
||||
## 0.2.0a16 (2025-04-30)
|
||||
|
||||
### Fix
|
||||
|
||||
- update translation
|
||||
- remove negative_description support
|
||||
- better documentation with hidden variable in property calculation
|
||||
- use new information ymlfiles
|
||||
- update tests
|
||||
- better dynamic support
|
||||
|
||||
## 0.2.0a15 (2025-04-09)
|
||||
|
||||
### Fix
|
||||
|
||||
- version
|
||||
|
||||
## 0.2.0a14 (2025-04-07)
|
||||
|
||||
### Fix
|
||||
|
||||
- calculation for dynamic ans leadership variables
|
||||
|
||||
## 0.2.0a13 (2025-04-02)
|
||||
|
||||
### Fix
|
||||
|
||||
- error in disabled dynamic variable
|
||||
|
||||
## 0.2.0a12 (2025-04-01)
|
||||
|
||||
### Fix
|
||||
|
||||
- update tests
|
||||
- groups.namespace could be unexistant
|
||||
|
||||
## 0.2.0a11 (2025-03-31)
|
||||
|
||||
### Fix
|
||||
|
||||
- doc a param with a set but with only one item
|
||||
|
||||
## 0.2.0a10 (2025-03-30)
|
||||
|
||||
### Feat
|
||||
|
||||
- document unix file name parameters
|
||||
- better console output
|
||||
- do not document reference to undocumented variable
|
||||
|
||||
### Fix
|
||||
|
||||
- doc for param
|
||||
- support NamespaceCalculation
|
||||
- convert <ENV> to <ENV> for github plugin
|
||||
|
||||
## 0.2.0a9 (2025-02-19)
|
||||
|
||||
### Fix
|
||||
|
||||
- support suffix (in version 1.0 format) in calculation
|
||||
|
||||
## 0.2.0a8 (2025-02-19)
|
||||
|
||||
### Fix
|
||||
|
||||
- key is the path
|
||||
|
||||
## 0.2.0a7 (2025-02-19)
|
||||
|
||||
### Fix
|
||||
|
||||
- with_family => without_family and with_example => example
|
||||
|
||||
## 0.2.0a6 (2025-02-17)
|
||||
|
||||
### Feat
|
||||
|
||||
- add with_family parameter
|
||||
|
||||
## 0.2.0a5 (2025-02-17)
|
||||
|
||||
### Fix
|
||||
|
||||
- do not add multiple attribute several time in json export
|
||||
|
||||
## 0.2.0a4 (2025-02-10)
|
||||
|
||||
### Feat
|
||||
|
||||
- output return status too
|
||||
|
||||
## 0.2.0a3 (2025-01-04)
|
||||
|
||||
### Fix
|
||||
|
||||
- detect_symlink => only_self
|
||||
|
||||
## 0.2.0a2 (2025-01-04)
|
||||
|
||||
### Feat
|
||||
|
||||
- create tests
|
||||
|
||||
### Fix
|
||||
|
||||
- do not document symlink
|
||||
- remove prefix_path
|
||||
|
||||
## 0.2.0a1 (2024-11-28)
|
||||
|
||||
### Fix
|
||||
|
||||
- separation between run and print function
|
||||
|
||||
## 0.2.0a0 (2024-11-20)
|
||||
|
||||
### Feat
|
||||
|
||||
- personalize mode that we want disable documentation
|
||||
- add console output
|
||||
- better dynamique family support
|
||||
- add json output
|
||||
|
||||
### Fix
|
||||
|
||||
- correction for properties in italic
|
||||
|
||||
## 0.1.1a0 (2024-11-08)
|
||||
|
||||
### Fix
|
||||
|
||||
- generate documentation with force_optional configuration
|
||||
|
||||
### Refactor
|
||||
|
||||
- **locale-po**: locale translation
|
||||
- **typo**: french translation type
|
||||
|
||||
## 0.1.0 (2024-11-06)
|
||||
|
||||
## 0.1.0rc1 (2024-11-06)
|
||||
|
|
|
|||
|
|
@ -391,8 +391,8 @@ msgid "Example with mandatory variables not filled in"
|
|||
msgstr "Exemple avec des variables obligatoire non renseignée"
|
||||
|
||||
#: src/rougail/output_doc/example.py:63
|
||||
msgid "Example with all modifiable variables"
|
||||
msgstr "Exemple avec toutes les variables modifiables"
|
||||
msgid "Example with all variables modifiable"
|
||||
msgstr "Exemple avec toutes les variables modifiable"
|
||||
|
||||
#: src/rougail/output_doc/output/asciidoc.py:156
|
||||
#: src/rougail/output_doc/output/console.py:234
|
||||
|
|
|
|||
|
|
@ -341,7 +341,7 @@ msgid "Example with mandatory variables not filled in"
|
|||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/example.py:63
|
||||
msgid "Example with all modifiable variables"
|
||||
msgid "Example with all variables modifiable"
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/output/asciidoc.py:156
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ requires = ["flit_core >=3.8.0,<4"]
|
|||
|
||||
[project]
|
||||
name = "rougail.output_doc"
|
||||
version = "1.0.3"
|
||||
version = "1.0.0rc1"
|
||||
authors = [{name = "Emmanuel Garette", email = "gnunux@gnunux.info"}]
|
||||
readme = "README.md"
|
||||
description = "Rougail output doc"
|
||||
|
|
@ -24,8 +24,8 @@ classifiers = [
|
|||
|
||||
]
|
||||
dependencies = [
|
||||
"rougail-base >= 1.2.0,<2",
|
||||
"tabulate ~= 0.10.0", # same as rougail-output-table
|
||||
"rougail-base > 1.1,<2",
|
||||
"tabulate ~= 0.9.0",
|
||||
"rich ~= 13.9.3",
|
||||
]
|
||||
|
||||
|
|
|
|||
|
|
@ -1 +1 @@
|
|||
__version__ = "1.0.3"
|
||||
__version__ = "1.0.0rc1"
|
||||
|
|
|
|||
|
|
@ -64,9 +64,7 @@ class Annotator(Walk):
|
|||
else:
|
||||
self.default_values = self.objectspace.rougailconfig["doc.default_values"]
|
||||
if "force_display_unknown_optional_variable" in kwargs:
|
||||
self.display_unknown_optional_variable = kwargs[
|
||||
"force_display_unknown_optional_variable"
|
||||
]
|
||||
self.display_unknown_optional_variable = kwargs["force_display_unknown_optional_variable"]
|
||||
else:
|
||||
self.display_unknown_optional_variable = False
|
||||
self.regexp_description_get_paths = None
|
||||
|
|
@ -266,19 +264,16 @@ class Annotator(Walk):
|
|||
values.xmlfiles,
|
||||
)
|
||||
if variable:
|
||||
val_description = val_description.replace(
|
||||
f'"{r_path}"', f"{{{index}}}"
|
||||
)
|
||||
val_description = val_description.replace(f'"{r_path}"', f'{{{index}}}')
|
||||
v = {"path": variable.path, "description": variable.description}
|
||||
if identifiers:
|
||||
v["identifiers"] = [identifiers]
|
||||
v["identifier_type"] = "many"
|
||||
variables.append(v)
|
||||
index += 1
|
||||
description = {
|
||||
"description": True,
|
||||
"value": val_description,
|
||||
}
|
||||
description = {"description": True,
|
||||
"value": val_description,
|
||||
}
|
||||
if variables:
|
||||
description["variables"] = variables
|
||||
else:
|
||||
|
|
|
|||
|
|
@ -178,9 +178,7 @@ class Changelog: # pylint: disable=no-member,too-few-public-methods
|
|||
else:
|
||||
title = _("Deleted variables")
|
||||
lst.append(self.formatter.title(title, self.level))
|
||||
lst.append(
|
||||
self.formatter.list(self._removed_variables, inside_tabular=False)
|
||||
)
|
||||
lst.append(self.formatter.list(self._removed_variables, inside_tabular=False))
|
||||
end = self.formatter.end_family(self.level)
|
||||
if end:
|
||||
lst.append(end)
|
||||
|
|
|
|||
|
|
@ -24,11 +24,7 @@ from tiramisu.error import display_list, PropertiesOptionError
|
|||
from tiramisu.config import get_common_path
|
||||
from rougail.tiramisu import display_xmlfiles
|
||||
from rougail.utils import PROPERTY_ATTRIBUTE
|
||||
from rougail.error import (
|
||||
VariableCalculationDependencyError,
|
||||
RougailWarning,
|
||||
ExtensionError,
|
||||
)
|
||||
from rougail.error import VariableCalculationDependencyError, RougailWarning, ExtensionError
|
||||
|
||||
from .utils import dump, to_phrase, calc_path, add_dot, doc_path
|
||||
from .i18n import _
|
||||
|
|
@ -71,9 +67,7 @@ class _ToString:
|
|||
return ret[0]
|
||||
return ret
|
||||
|
||||
def _calculation_to_string(
|
||||
self, child, calculation, attribute_type, inside_list=True
|
||||
):
|
||||
def _calculation_to_string(self, child, calculation, attribute_type, inside_list=True):
|
||||
if calculation.get("description", False):
|
||||
values = calculation.copy()
|
||||
if self.document_a_type and "variables" in values:
|
||||
|
|
@ -116,9 +110,7 @@ class _ToString:
|
|||
if not inside_list:
|
||||
msg = add_dot(msg)
|
||||
variable = self.true_config.unrestraint.option(calculation["path"])
|
||||
values = self._calculation_with_variable(
|
||||
child, variable, calculation, msg
|
||||
)
|
||||
values = self._calculation_with_variable(child, variable, calculation, msg)
|
||||
else:
|
||||
values = _('the value of the global information "{0}"').format(
|
||||
calculation["information"]
|
||||
|
|
@ -172,7 +164,7 @@ class _ToString:
|
|||
child, option, condition.get("identifiers")
|
||||
)
|
||||
else:
|
||||
# option = self.true_config.option(variable_path)
|
||||
# option = self.true_config.option(variable_path)
|
||||
try:
|
||||
is_inaccessible = self.is_inaccessible_user_data(option)
|
||||
except AttributeError as err:
|
||||
|
|
@ -239,7 +231,7 @@ class _ToString:
|
|||
submsg = display_list(
|
||||
[_("is {0}").format(prop), submsg], separator="or", sort=False
|
||||
)
|
||||
msg = _("when the variable {{0}} {0}.").format(submsg)
|
||||
msg = _('when the variable {{0}} {0}.').format(submsg)
|
||||
path_obj = {
|
||||
"path": doc_path(variable_path, self.document_a_type),
|
||||
}
|
||||
|
|
@ -270,13 +262,11 @@ class _ToString:
|
|||
variable.get()
|
||||
except AttributeError:
|
||||
defined = False
|
||||
true_msg = _("the value of the variable {0} if it is defined")
|
||||
true_msg = _('the value of the variable {0} if it is defined')
|
||||
else:
|
||||
true_msg = _("the value of the variable {0}")
|
||||
true_msg = _('the value of the variable {0}')
|
||||
if defined:
|
||||
return self._calculation_with_variable(
|
||||
child, variable, calculation["value"], true_msg
|
||||
)
|
||||
return self._calculation_with_variable(child, variable, calculation["value"], true_msg)
|
||||
return {
|
||||
"message": true_msg,
|
||||
"path": calculation["value"],
|
||||
|
|
@ -290,7 +280,9 @@ class _ToString:
|
|||
func = self._calculation_dynamic_variable_with_variable
|
||||
return func(child, variable, calculation, msg)
|
||||
|
||||
def _calculation_normal_with_variable(self, child, variable, obj, msg):
|
||||
def _calculation_normal_with_variable(
|
||||
self, child, variable, obj, msg
|
||||
):
|
||||
isfollower = not variable.isoptiondescription() and variable.isfollower()
|
||||
if not isfollower and self.is_inaccessible_user_data(variable):
|
||||
uncalculated = variable.unrestraint.value.default(uncalculated=True)
|
||||
|
|
@ -303,7 +295,9 @@ class _ToString:
|
|||
else:
|
||||
if not isinstance(uncalculated, str):
|
||||
uncalculated = dump(uncalculated)
|
||||
msg = _("{0} (from an undocumented variable)").format(uncalculated)
|
||||
msg = _("{0} (from an undocumented variable)").format(
|
||||
uncalculated
|
||||
)
|
||||
else:
|
||||
msg = _("the value of an undocumented variable")
|
||||
try:
|
||||
|
|
@ -316,14 +310,13 @@ class _ToString:
|
|||
"description": description,
|
||||
}
|
||||
|
||||
def _calculation_dynamic_variable_with_variable(self, child, variable, obj, msg):
|
||||
def _calculation_dynamic_variable_with_variable(
|
||||
self, child, variable, obj, msg
|
||||
):
|
||||
values = []
|
||||
for (
|
||||
path,
|
||||
description,
|
||||
identifiers,
|
||||
identifier_type,
|
||||
) in self._get_annotation_variable(child, variable, obj.get("identifiers")):
|
||||
for path, description, identifiers, identifier_type in self._get_annotation_variable(
|
||||
child, variable, obj.get("identifiers")
|
||||
):
|
||||
variable = self.true_config.option(path)
|
||||
path_obj = {
|
||||
"path": doc_path(path, self.document_a_type),
|
||||
|
|
@ -332,7 +325,9 @@ class _ToString:
|
|||
path_obj["identifiers"] = identifiers
|
||||
path_obj["identifier_type"] = identifier_type
|
||||
values.append(
|
||||
self._calculation_normal_with_variable(child, variable, path_obj, msg)
|
||||
self._calculation_normal_with_variable(
|
||||
child, variable, path_obj, msg
|
||||
)
|
||||
)
|
||||
return values
|
||||
|
||||
|
|
@ -355,13 +350,13 @@ class _ToString:
|
|||
if ori_identifiers:
|
||||
if path.count("{{ identifier }}") == len(ori_identifiers):
|
||||
identifier_type = "one"
|
||||
elif "{{ identifier }}" in path[len(get_common_path(child_path, path)) :]:
|
||||
elif "{{ identifier }}" in path[len(get_common_path(child_path, path)):]:
|
||||
identifier_type = "outside"
|
||||
else:
|
||||
identifier_type = "inside"
|
||||
else:
|
||||
common_path = get_common_path(child_path, path)
|
||||
if common_path and "{{ identifier }}" in path[len(common_path) :]:
|
||||
if common_path and "{{ identifier }}" in path[len(common_path):]:
|
||||
identifier_type = "outside"
|
||||
else:
|
||||
identifier_type = "inside"
|
||||
|
|
@ -440,7 +435,7 @@ class Collect(_ToString):
|
|||
path = family.path(uncalculated=True)
|
||||
informations = {}
|
||||
if not self._collect(family, informations, family_type=family_type):
|
||||
return False
|
||||
return False, []
|
||||
if family_type == "sequence":
|
||||
informations.setdefault("help", []).append(
|
||||
_("This family contains lists of variable blocks")
|
||||
|
|
@ -645,11 +640,7 @@ class Collect(_ToString):
|
|||
annotation = False
|
||||
if child.information.get(f"{prop}_calculation", False):
|
||||
annotation = self._to_string(child, prop)
|
||||
if (
|
||||
not self.only_disabled
|
||||
and annotation is None
|
||||
and prop in HIDDEN_PROPERTIES
|
||||
):
|
||||
if not self.only_disabled and annotation is None and prop in HIDDEN_PROPERTIES:
|
||||
return False, []
|
||||
if annotation is True and prop in DISABLED_PROPERTIES:
|
||||
return False, []
|
||||
|
|
@ -706,7 +697,9 @@ class Collect(_ToString):
|
|||
)
|
||||
return None
|
||||
var_type = "variable" if family_type is None else "family"
|
||||
return self._convert_description(child.description(uncalculated=True), var_type)
|
||||
return self._convert_description(
|
||||
child.description(uncalculated=True), var_type
|
||||
)
|
||||
|
||||
def _convert_description(self, description, type_):
|
||||
return to_phrase(description, type_)
|
||||
|
|
@ -740,7 +733,9 @@ class Collect(_ToString):
|
|||
variable.value.get()
|
||||
except AttributeError:
|
||||
variable = None
|
||||
if variable and self.is_inaccessible_user_data(variable):
|
||||
if variable and self.is_inaccessible_user_data(
|
||||
variable
|
||||
):
|
||||
try:
|
||||
variable_value = self._get_unmodified_default_value(
|
||||
variable
|
||||
|
|
|
|||
|
|
@ -87,9 +87,7 @@ class RougailOutputDoc(Collect, Examples, Changelog):
|
|||
def load_formatter(self) -> str:
|
||||
output_format = self.rougailconfig["doc.output_format"]
|
||||
self.formatter = self.outputs[output_format](
|
||||
self.rougailconfig,
|
||||
support_namespace=self.support_namespace,
|
||||
document_a_type=self.document_a_type,
|
||||
self.rougailconfig, support_namespace=self.support_namespace, document_a_type=self.document_a_type
|
||||
)
|
||||
|
||||
def print(self) -> None:
|
||||
|
|
@ -117,8 +115,8 @@ class RougailOutputDoc(Collect, Examples, Changelog):
|
|||
self.dynamic_paths = {}
|
||||
if self.config.isoptiondescription():
|
||||
informations = self.collect_families(self.config.unrestraint)
|
||||
# from pprint import pprint
|
||||
# pprint(informations)
|
||||
# from pprint import pprint
|
||||
# pprint(informations)
|
||||
else:
|
||||
informations = {}
|
||||
self.collect_variable(self.config, informations)
|
||||
|
|
|
|||
|
|
@ -61,7 +61,7 @@ class Examples: # pylint: disable=no-member,too-few-public-methods
|
|||
if only_modified:
|
||||
title = _("Example with mandatory variables not filled in")
|
||||
else:
|
||||
title = _("Example with all modifiable variables")
|
||||
title = _("Example with all variables modifiable")
|
||||
datas.append(self.formatter.title(title, self.level))
|
||||
datas.append(self.formatter.yaml(dump(results)))
|
||||
end = self.formatter.end_family(self.level)
|
||||
|
|
@ -82,13 +82,7 @@ class Examples: # pylint: disable=no-member,too-few-public-methods
|
|||
self._set_mandatories(config)
|
||||
return config
|
||||
|
||||
def _gen_doc_examples(
|
||||
self,
|
||||
config,
|
||||
only_modified: bool,
|
||||
with_secret_manager: bool = True,
|
||||
with_calculated_value: bool = True,
|
||||
) -> dict:
|
||||
def _gen_doc_examples(self, config, only_modified: bool, with_secret_manager: bool=True, with_calculated_value: bool=True) -> dict:
|
||||
if not only_modified:
|
||||
self._set_examples(config)
|
||||
results = CommentedMap()
|
||||
|
|
@ -113,26 +107,18 @@ class Examples: # pylint: disable=no-member,too-few-public-methods
|
|||
n_results = n_results[name]
|
||||
if only_modified:
|
||||
if with_calculated_value:
|
||||
dump_type = "modified"
|
||||
dump_type = 'modified'
|
||||
else:
|
||||
dump_type = "empty"
|
||||
else:
|
||||
dump_type = "all"
|
||||
dump_type = 'all'
|
||||
if root_config.isoptiondescription():
|
||||
self._example_parse_family(
|
||||
root_config.value.get(),
|
||||
results,
|
||||
dump_type,
|
||||
with_secret_manager=with_secret_manager,
|
||||
root_config.value.get(), results, dump_type, with_secret_manager=with_secret_manager
|
||||
)
|
||||
else:
|
||||
self._set_example_value(
|
||||
results,
|
||||
root_config,
|
||||
root_config.value.get(),
|
||||
dump_type,
|
||||
with_secret_manager,
|
||||
False,
|
||||
results, root_config, root_config.value.get(), dump_type, with_secret_manager, False
|
||||
)
|
||||
if true_results and results:
|
||||
n_results.update(results)
|
||||
|
|
@ -217,51 +203,26 @@ class Examples: # pylint: disable=no-member,too-few-public-methods
|
|||
return option.issubmulti()
|
||||
return option.ismulti()
|
||||
|
||||
def _example_parse_family(
|
||||
self,
|
||||
config,
|
||||
results,
|
||||
dump_type,
|
||||
*,
|
||||
with_secret_manager: bool = True,
|
||||
with_true_path: bool = False,
|
||||
) -> None:
|
||||
def _example_parse_family(self, config, results, dump_type, *, with_secret_manager: bool=True, with_true_path: bool=False) -> None:
|
||||
for option, values in config.items():
|
||||
if option.isoptiondescription():
|
||||
if option.isleadership():
|
||||
subresults = self._example_parse_sequence(
|
||||
values, dump_type, with_secret_manager, with_true_path
|
||||
)
|
||||
subresults = self._example_parse_sequence(values, dump_type, with_secret_manager, with_true_path)
|
||||
if subresults:
|
||||
name = option.name(uncalculated=with_true_path)
|
||||
results[name] = subresults
|
||||
self._set_description(results, name, option)
|
||||
else:
|
||||
subresults = CommentedMap()
|
||||
self._example_parse_family(
|
||||
values,
|
||||
subresults,
|
||||
dump_type,
|
||||
with_secret_manager=with_secret_manager,
|
||||
with_true_path=with_true_path,
|
||||
)
|
||||
self._example_parse_family(values, subresults, dump_type, with_secret_manager=with_secret_manager, with_true_path=with_true_path)
|
||||
if subresults:
|
||||
name = option.name(uncalculated=with_true_path)
|
||||
results[name] = subresults
|
||||
self._set_description(results, name, option)
|
||||
else:
|
||||
self._set_example_value(
|
||||
results,
|
||||
option,
|
||||
values,
|
||||
dump_type,
|
||||
with_secret_manager,
|
||||
with_true_path,
|
||||
)
|
||||
self._set_example_value(results, option, values, dump_type, with_secret_manager, with_true_path)
|
||||
|
||||
def _set_example_value(
|
||||
self, results, option, values, dump_type, with_secret_manager, with_true_path
|
||||
):
|
||||
def _set_example_value(self, results, option, values, dump_type, with_secret_manager, with_true_path):
|
||||
if not self._is_valid_owner(option, dump_type):
|
||||
return
|
||||
if not with_secret_manager and option.information.get("secret_manager", False):
|
||||
|
|
@ -281,50 +242,22 @@ class Examples: # pylint: disable=no-member,too-few-public-methods
|
|||
return "hidden" in option.property.get()
|
||||
is_default = option.owner.isdefault()
|
||||
return (
|
||||
(
|
||||
dump_type == "modified"
|
||||
and not is_default
|
||||
and option.owner.get() != owners.forced
|
||||
)
|
||||
or (
|
||||
dump_type == "empty"
|
||||
and "hidden" in option.property.get()
|
||||
and not option.information.get("default_calculation", None)
|
||||
and (
|
||||
option.value.default(uncalculated=True) in [None, []]
|
||||
or not option.information.get("default_value_makes_sense", True)
|
||||
)
|
||||
)
|
||||
or (dump_type == "default" and is_default)
|
||||
(dump_type == 'modified' and not is_default and option.owner.get() != owners.forced)
|
||||
or (dump_type == "empty" and "hidden" in option.property.get() and not option.information.get("default_calculation", None) and (option.value.default(uncalculated=True) in [None, []] or not option.information.get("default_value_makes_sense", True)))
|
||||
or (dump_type == 'default' and is_default)
|
||||
)
|
||||
|
||||
def _example_parse_sequence(
|
||||
self, values, dump_type, with_secret_manager, with_true_path
|
||||
):
|
||||
def _example_parse_sequence(self, values, dump_type, with_secret_manager, with_true_path):
|
||||
sequence_iter = iter(values.items())
|
||||
leader, leader_values = next(sequence_iter)
|
||||
if not self._is_valid_owner(leader, dump_type):
|
||||
return None
|
||||
sequence = [CommentedMap() for idx in range(len(leader_values))]
|
||||
for idx, value in enumerate(leader_values):
|
||||
self._set_example_value(
|
||||
sequence[idx],
|
||||
leader,
|
||||
value,
|
||||
dump_type,
|
||||
with_secret_manager,
|
||||
with_true_path,
|
||||
)
|
||||
self._set_example_value(sequence[idx], leader, value, dump_type, with_secret_manager, with_true_path)
|
||||
for option, value in sequence_iter:
|
||||
idx = option.index()
|
||||
self._set_example_value(
|
||||
sequence[idx],
|
||||
option,
|
||||
value,
|
||||
dump_type,
|
||||
with_secret_manager,
|
||||
with_true_path,
|
||||
)
|
||||
self._set_example_value(sequence[idx], option, value, dump_type, with_secret_manager, with_true_path)
|
||||
return sequence
|
||||
|
||||
def _set_description(self, results, name, option):
|
||||
|
|
|
|||
Binary file not shown.
|
|
@ -21,7 +21,6 @@ from typing import List
|
|||
from ..i18n import _
|
||||
from rougail.error import ExtensionError
|
||||
from ..utils import dump, CommonFormatter
|
||||
|
||||
try:
|
||||
from rich.jupyter import JupyterMixin
|
||||
from rich.segment import Segment
|
||||
|
|
@ -35,7 +34,6 @@ except ModuleNotFoundError:
|
|||
|
||||
|
||||
if Console:
|
||||
|
||||
class BlockQuote(JupyterMixin):
|
||||
def __init__(
|
||||
self,
|
||||
|
|
@ -74,9 +72,7 @@ class Formatter(CommonFormatter):
|
|||
|
||||
def __init__(self, rougailconfig, **kwargs) -> None:
|
||||
if not Console:
|
||||
raise ExtensionError(
|
||||
_("cannot find Python module Rich, please install it!")
|
||||
)
|
||||
raise ExtensionError(_("cannot find Python module Rich, please install it!"))
|
||||
self.custom_theme = Theme(self.titles_color)
|
||||
self.max_line = 0
|
||||
super().__init__(rougailconfig, **kwargs)
|
||||
|
|
@ -91,7 +87,9 @@ class Formatter(CommonFormatter):
|
|||
force_terminal = "xterm-256color"
|
||||
else:
|
||||
force_terminal = None
|
||||
console = Console(theme=self.custom_theme, force_terminal=force_terminal)
|
||||
console = Console(
|
||||
theme=self.custom_theme, force_terminal=force_terminal
|
||||
)
|
||||
with console.capture() as capture:
|
||||
for data in dico:
|
||||
console.print(data)
|
||||
|
|
@ -102,7 +100,7 @@ class Formatter(CommonFormatter):
|
|||
self,
|
||||
title: str,
|
||||
level: int,
|
||||
collapse: bool = True,
|
||||
collapse: bool=True,
|
||||
) -> str:
|
||||
"""Display family name as a title"""
|
||||
space = " " * (2 * (level - 1))
|
||||
|
|
|
|||
|
|
@ -45,7 +45,7 @@ class Formatter(CommonFormatter):
|
|||
self,
|
||||
title: str,
|
||||
level: int,
|
||||
collapse: bool = True,
|
||||
collapse: bool=True,
|
||||
) -> str:
|
||||
"""Display family name as a title"""
|
||||
char = "#"
|
||||
|
|
|
|||
|
|
@ -29,17 +29,16 @@ class Formatter(GithubFormatter):
|
|||
level = 51
|
||||
format_in_title = False
|
||||
|
||||
def title(
|
||||
self,
|
||||
title: str,
|
||||
level: int,
|
||||
collapse: bool = True,
|
||||
) -> str:
|
||||
def title(self,
|
||||
title: str,
|
||||
level: int,
|
||||
collapse: bool=True,
|
||||
) -> str:
|
||||
if collapse:
|
||||
return "<details><summary>" + title + "</summary>"
|
||||
return super().title(title, level, collapse)
|
||||
|
||||
def end_family(self, level, collapse: bool = True):
|
||||
def end_family(self, level, collapse: bool=True):
|
||||
if collapse:
|
||||
return "</details>"
|
||||
return None
|
||||
|
|
@ -62,9 +61,8 @@ class Formatter(GithubFormatter):
|
|||
|
||||
def family_informations_starts_line(self) -> str:
|
||||
return "\n> "
|
||||
|
||||
# def list(self, *args, **kwargs):
|
||||
# return super().list(*args, **kwargs) + "\n"
|
||||
# def list(self, *args, **kwargs):
|
||||
# return super().list(*args, **kwargs) + "\n"
|
||||
|
||||
def family_informations_starts_list_first(self):
|
||||
return ""
|
||||
|
|
|
|||
|
|
@ -55,10 +55,10 @@ def dump(informations):
|
|||
|
||||
def to_phrase(msg, type_="variable"):
|
||||
"""Add maj for the first character and ends with dot"""
|
||||
msg = str(msg).strip()
|
||||
if not msg:
|
||||
# replace None to empty string
|
||||
return ""
|
||||
msg = str(msg).strip()
|
||||
# a phrase must ends with a dot
|
||||
if type_ == "variable":
|
||||
msg = add_dot(msg)
|
||||
|
|
@ -286,11 +286,11 @@ class CommonFormatter:
|
|||
if not self.rougailconfig["main_namespace"] and self.with_environment:
|
||||
environment_prefix = self.rougailconfig["doc.tabulars.environment_prefix"]
|
||||
if environment_prefix:
|
||||
self.prefix = environment_prefix + "_"
|
||||
self.prefix = (
|
||||
environment_prefix + "_"
|
||||
)
|
||||
self.with_family = not self.rougailconfig["doc.tabulars.without_family"]
|
||||
self.other_root_filenames = dict(
|
||||
self.rougailconfig["doc.other_root_filenames"].items()
|
||||
)
|
||||
self.other_root_filenames = dict(self.rougailconfig["doc.other_root_filenames"].items())
|
||||
tabular_template = self.rougailconfig["doc.tabular_template"]
|
||||
self.tabular_datas = Tabulars().get()[tabular_template](self)
|
||||
|
||||
|
|
@ -302,7 +302,7 @@ class CommonFormatter:
|
|||
self,
|
||||
title: str,
|
||||
level: int,
|
||||
collapse: bool = True,
|
||||
collapse: bool=True,
|
||||
) -> str:
|
||||
"""Display family name as a title"""
|
||||
raise NotImplementedError()
|
||||
|
|
@ -385,10 +385,10 @@ class CommonFormatter:
|
|||
"""Add a link"""
|
||||
raise NotImplementedError()
|
||||
|
||||
def yaml(self, _dump: str, yaml_version: str = "1.1"):
|
||||
def yaml(self, _dump: str, yaml_version: str="1.1"):
|
||||
output = f"---\n{_dump}"
|
||||
if yaml_version == "1.2":
|
||||
output = f"%YAML 1.2\n{output}\n..."
|
||||
output = f'%YAML 1.2\n{output}\n...'
|
||||
return self._yaml(output)
|
||||
|
||||
##################
|
||||
|
|
@ -414,7 +414,6 @@ class CommonFormatter:
|
|||
|
||||
def anchor(path, true_path):
|
||||
return path
|
||||
|
||||
ret_paths = []
|
||||
path = informations["path"]
|
||||
if not path:
|
||||
|
|
@ -538,8 +537,7 @@ class CommonFormatter:
|
|||
else:
|
||||
ret = [
|
||||
self.title(
|
||||
self.get_description(informations, {}, title=True),
|
||||
level,
|
||||
self.get_description(informations, {}, title=True), level,
|
||||
)
|
||||
]
|
||||
msg = []
|
||||
|
|
@ -569,10 +567,7 @@ class CommonFormatter:
|
|||
full_path = informations["path"]
|
||||
msg.append(
|
||||
self.section(
|
||||
full_path,
|
||||
_("Identifiers"),
|
||||
informations["identifier"],
|
||||
type_="family",
|
||||
full_path, _("Identifiers"), informations["identifier"], type_="family"
|
||||
)
|
||||
)
|
||||
if msg:
|
||||
|
|
@ -598,7 +593,7 @@ class CommonFormatter:
|
|||
def family_informations_ends_line(self) -> str:
|
||||
return ""
|
||||
|
||||
def end_family(self, level: int, collapse: bool = True) -> str:
|
||||
def end_family(self, level: int, collapse: bool=True) -> str:
|
||||
return None
|
||||
|
||||
def convert_list_to_string(
|
||||
|
|
@ -632,21 +627,12 @@ class CommonFormatter:
|
|||
informations: dict,
|
||||
modified_attributes: dict,
|
||||
*,
|
||||
force_identifiers: Optional[list] = None,
|
||||
with_to_phrase: bool = True,
|
||||
title: bool = False,
|
||||
force_identifiers: Optional[list]=None,
|
||||
with_to_phrase: bool=True,
|
||||
title: bool=False,
|
||||
) -> str:
|
||||
add_new_description = True
|
||||
|
||||
def _get_description(
|
||||
description,
|
||||
identifiers,
|
||||
delete=False,
|
||||
new=[],
|
||||
previous_identifiers=[],
|
||||
new_identifiers=[],
|
||||
its_a_name=False,
|
||||
):
|
||||
def _get_description(description, identifiers, delete=False, new=[], previous_identifiers=[], new_identifiers=[], its_a_name=False):
|
||||
if identifiers and "{{ identifier }}" in description:
|
||||
if its_a_name:
|
||||
information_type = "name"
|
||||
|
|
@ -667,15 +653,14 @@ class CommonFormatter:
|
|||
formatter = self
|
||||
else:
|
||||
formatter = None
|
||||
description = get_path_from_identifiers(
|
||||
description,
|
||||
identifiers,
|
||||
previous_identifiers,
|
||||
new_identifiers,
|
||||
identifier_type,
|
||||
formatter=formatter,
|
||||
information_type=information_type,
|
||||
)
|
||||
description = get_path_from_identifiers(description,
|
||||
identifiers,
|
||||
previous_identifiers,
|
||||
new_identifiers,
|
||||
identifier_type,
|
||||
formatter=formatter,
|
||||
information_type=information_type,
|
||||
)
|
||||
elif with_to_phrase:
|
||||
description = self.to_phrase(description)
|
||||
if description in new:
|
||||
|
|
@ -700,25 +685,15 @@ class CommonFormatter:
|
|||
)
|
||||
else:
|
||||
modified_description = None
|
||||
elif (
|
||||
"identifiers" in modified_attributes
|
||||
and "{{ identifier }}" in informations["description"]
|
||||
):
|
||||
elif "identifiers" in modified_attributes and "{{ identifier }}" in informations["description"]:
|
||||
# FIXME aussi au dessus !
|
||||
name, previous, new = modified_attributes["identifiers"]
|
||||
previous_identifiers = previous[-1] if previous else []
|
||||
new_identifiers = new[-1] if new else []
|
||||
if new_identifiers:
|
||||
all_identifiers = [
|
||||
identifier
|
||||
for identifier in all_identifiers
|
||||
if identifier != new_identifiers
|
||||
]
|
||||
all_identifiers = [identifier for identifier in all_identifiers if identifier != new_identifiers]
|
||||
modified_description = _get_description(
|
||||
informations["description"],
|
||||
all_identifiers,
|
||||
previous_identifiers=previous_identifiers,
|
||||
new_identifiers=new_identifiers,
|
||||
informations["description"], all_identifiers, previous_identifiers=previous_identifiers, new_identifiers=new_identifiers
|
||||
)
|
||||
add_new_description = False
|
||||
else:
|
||||
|
|
@ -731,10 +706,7 @@ class CommonFormatter:
|
|||
)
|
||||
else:
|
||||
description = _get_description(
|
||||
informations["name"],
|
||||
all_identifiers,
|
||||
new=new,
|
||||
its_a_name=True,
|
||||
informations["name"], all_identifiers, new=new, its_a_name=True,
|
||||
)
|
||||
else:
|
||||
description = None
|
||||
|
|
@ -780,9 +752,7 @@ class CommonFormatter:
|
|||
submessage, m = self.message_to_string(full_path, p, submessage)
|
||||
values.append(self.delete(m))
|
||||
else:
|
||||
submessage, old_values = self.message_to_string(
|
||||
full_path, previous, submessage
|
||||
)
|
||||
submessage, old_values = self.message_to_string(full_path, previous, submessage)
|
||||
values.append(self.delete(old_values))
|
||||
else:
|
||||
new = []
|
||||
|
|
@ -791,15 +761,11 @@ class CommonFormatter:
|
|||
name = old["name"]
|
||||
if isinstance(old["values"], list):
|
||||
for value in old["values"]:
|
||||
if "identifiers" in informations and (
|
||||
not isinstance(value, dict) or "identifiers" not in value
|
||||
):
|
||||
if "identifiers" in informations and (not isinstance(value, dict) or "identifiers" not in value):
|
||||
identifiers = informations["identifiers"]
|
||||
else:
|
||||
identifiers = []
|
||||
submessage, old_value = self.message_to_string(
|
||||
full_path, value, submessage, force_identifiers=identifiers
|
||||
)
|
||||
submessage, old_value = self.message_to_string(full_path, value, submessage, force_identifiers=identifiers)
|
||||
if value in new:
|
||||
old_value = self.underline(old_value)
|
||||
values.append(old_value)
|
||||
|
|
@ -809,24 +775,18 @@ class CommonFormatter:
|
|||
values = self.join(values)
|
||||
elif values:
|
||||
old_values = old["values"]
|
||||
submessage, old_values = self.message_to_string(
|
||||
full_path, old_values, submessage
|
||||
)
|
||||
submessage, old_values = self.message_to_string(full_path, old_values, submessage)
|
||||
if old["values"] in new:
|
||||
old_values = self.underline(old_values)
|
||||
values.append(old_values)
|
||||
values = self.join(values)
|
||||
else:
|
||||
old_values = old["values"]
|
||||
if "identifiers" in informations and (
|
||||
not isinstance(old_values, dict) or "identifiers" not in old_values
|
||||
):
|
||||
if "identifiers" in informations and (not isinstance(old_values, dict) or "identifiers" not in old_values):
|
||||
identifiers = informations["identifiers"]
|
||||
else:
|
||||
identifiers = []
|
||||
submessage, values = self.message_to_string(
|
||||
full_path, old_values, submessage, force_identifiers=identifiers
|
||||
)
|
||||
submessage, values = self.message_to_string(full_path, old_values, submessage, force_identifiers=identifiers)
|
||||
if old["values"] in new:
|
||||
values = self.underline(values)
|
||||
if values != []:
|
||||
|
|
@ -860,9 +820,7 @@ class CommonFormatter:
|
|||
full_path = informations["path"]
|
||||
for idx, choice in enumerate(choices_values.copy()):
|
||||
if isinstance(choice, dict):
|
||||
choices_values[idx] = self.message_to_string(
|
||||
full_path, choice, None
|
||||
)[1]
|
||||
choices_values[idx] = self.message_to_string(full_path, choice, None)[1]
|
||||
if "default" in modified_attributes:
|
||||
name, old_default, new_default = modified_attributes["default"]
|
||||
if not old_default:
|
||||
|
|
@ -951,9 +909,7 @@ class CommonFormatter:
|
|||
# if old value and new value is a list, display a list
|
||||
if not default_is_a_list and len(choices_values) == 1:
|
||||
choices_values = choices_values[0]
|
||||
return default_is_already_set, self.section(
|
||||
full_path, choices["name"], choices_values
|
||||
)
|
||||
return default_is_already_set, self.section(full_path, choices["name"], choices_values)
|
||||
return default_is_already_set, None
|
||||
|
||||
# OTHERs
|
||||
|
|
@ -981,20 +937,13 @@ class CommonFormatter:
|
|||
)
|
||||
)
|
||||
if "multiple" in modified_attributes:
|
||||
if (
|
||||
modified_attributes["multiple"][1]
|
||||
and modified_attributes["multiple"][1][0]
|
||||
):
|
||||
if modified_attributes["multiple"][1] and modified_attributes["multiple"][1][0]:
|
||||
properties.append(
|
||||
self.prop(
|
||||
"multiple", italic=False, delete=True, underline=False
|
||||
)
|
||||
self.prop("multiple", italic=False, delete=True, underline=False)
|
||||
)
|
||||
else:
|
||||
properties.append(
|
||||
self.prop(
|
||||
"multiple", italic=False, delete=False, underline=True
|
||||
)
|
||||
self.prop("multiple", italic=False, delete=False, underline=True)
|
||||
)
|
||||
if "properties" not in contents and "properties" in modified_attributes:
|
||||
for prop in modified_attributes["properties"]:
|
||||
|
|
@ -1137,9 +1086,7 @@ class CommonFormatter:
|
|||
) in local_calculated_properties.items():
|
||||
data = []
|
||||
for calc in calculated_property:
|
||||
annotation = self.message_to_string(
|
||||
full_path, calc["annotation"], None
|
||||
)[1]
|
||||
annotation = self.message_to_string(full_path, calc["annotation"], None)[1]
|
||||
if calc.get("underline", False):
|
||||
annotation = self.underline(annotation)
|
||||
if calc.get("delete", False):
|
||||
|
|
@ -1151,9 +1098,7 @@ class CommonFormatter:
|
|||
calculated_property = data[0]
|
||||
calculated_properties.append(
|
||||
self.section(
|
||||
full_path,
|
||||
calculated_property_name.capitalize(),
|
||||
calculated_property,
|
||||
full_path, calculated_property_name.capitalize(), calculated_property
|
||||
)
|
||||
)
|
||||
if not properties:
|
||||
|
|
@ -1181,10 +1126,12 @@ class CommonFormatter:
|
|||
headers = self.tabular_header(self.tabular_datas.headers())
|
||||
else:
|
||||
headers = ()
|
||||
msg = tabulate(
|
||||
self.tabular_datas.get(),
|
||||
headers=headers,
|
||||
tablefmt=self._tabular_name,
|
||||
msg = (
|
||||
tabulate(
|
||||
self.tabular_datas.get(),
|
||||
headers=headers,
|
||||
tablefmt=self._tabular_name,
|
||||
)
|
||||
)
|
||||
return msg
|
||||
|
||||
|
|
@ -1206,32 +1153,18 @@ class CommonFormatter:
|
|||
filename = self.other_root_filenames["."]
|
||||
if "identifiers" in msg["path"]:
|
||||
msg["identifiers"] = msg["path"]["identifiers"]
|
||||
calculated_paths = calc_path(
|
||||
msg["path"], formatter=self, identifiers=force_identifiers
|
||||
)
|
||||
calculated_paths = calc_path(msg["path"], formatter=self, identifiers=force_identifiers)
|
||||
if self.support_namespace and self.document_a_type:
|
||||
namespace = full_path.split(".", 1)[0]
|
||||
else:
|
||||
namespace = None
|
||||
if isinstance(calculated_paths, list):
|
||||
msgs = [
|
||||
msg["message"].format(
|
||||
self.link_variable(
|
||||
doc_path(
|
||||
calculated_path, self.document_a_type, namespace
|
||||
),
|
||||
msg["path"]["path"],
|
||||
self.get_description(
|
||||
msg,
|
||||
{},
|
||||
force_identifiers=[msg["path"]["identifiers"][idx]],
|
||||
with_to_phrase=False,
|
||||
),
|
||||
filename=filename,
|
||||
)
|
||||
)
|
||||
for idx, calculated_path in enumerate(calculated_paths)
|
||||
]
|
||||
msgs = [msg["message"].format(self.link_variable(
|
||||
doc_path(calculated_path, self.document_a_type, namespace),
|
||||
msg["path"]["path"],
|
||||
self.get_description(msg, {}, force_identifiers=[msg["path"]["identifiers"][idx]], with_to_phrase=False),
|
||||
filename=filename,
|
||||
)) for idx, calculated_path in enumerate(calculated_paths)]
|
||||
msg = self.list(msgs)
|
||||
else:
|
||||
path = self.link_variable(
|
||||
|
|
@ -1332,18 +1265,10 @@ def calc_path(path, *, formatter=None, identifiers: List[str] = None) -> str:
|
|||
if formatter:
|
||||
identifier = formatter.italic(identifier)
|
||||
return path.replace("{{ identifier }}", identifier, 1)
|
||||
|
||||
if isinstance(path, dict):
|
||||
path_ = path["path"]
|
||||
if "identifiers" in path:
|
||||
path_ = get_path_from_identifiers(
|
||||
path["path"],
|
||||
path["identifiers"],
|
||||
[],
|
||||
[],
|
||||
path["identifier_type"],
|
||||
formatter,
|
||||
)
|
||||
path_ = get_path_from_identifiers(path["path"], path["identifiers"], [], [], path["identifier_type"], formatter)
|
||||
elif identifiers:
|
||||
for identifier in identifiers[0]:
|
||||
path_ = _path_with_identifier(path_, identifier)
|
||||
|
|
@ -1357,36 +1282,34 @@ def calc_path(path, *, formatter=None, identifiers: List[str] = None) -> str:
|
|||
return path_
|
||||
|
||||
|
||||
def doc_path(path, document_a_type, namespace: Optional[str] = None) -> str:
|
||||
def doc_path(path, document_a_type, namespace: Optional[str]=None) -> str:
|
||||
if document_a_type:
|
||||
if "." not in path:
|
||||
return None
|
||||
if not namespace or path.startswith(namespace + "."):
|
||||
if not namespace or path.startswith(namespace + '.'):
|
||||
return path.split(".", 1)[-1]
|
||||
return path
|
||||
|
||||
|
||||
def get_path_from_identifiers(
|
||||
text: str,
|
||||
all_identifiers: list,
|
||||
previous_identifiers: list,
|
||||
new_identifiers: list,
|
||||
identifier_type: str,
|
||||
formatter: Optional[object] = None,
|
||||
information_type="path",
|
||||
) -> str:
|
||||
def get_path_from_identifiers(text: str,
|
||||
all_identifiers: list,
|
||||
previous_identifiers: list,
|
||||
new_identifiers: list,
|
||||
identifier_type: str,
|
||||
formatter: Optional[object]=None,
|
||||
information_type="path",
|
||||
) -> str:
|
||||
if not isinstance(all_identifiers, list):
|
||||
raise Exception("hu1?")
|
||||
raise Exception('hu1?')
|
||||
if all_identifiers:
|
||||
for i in all_identifiers:
|
||||
if not isinstance(i, list):
|
||||
raise Exception("hu2?")
|
||||
raise Exception('hu2?')
|
||||
for j in i:
|
||||
if isinstance(j, list):
|
||||
raise Exception("hu3?")
|
||||
raise Exception('hu3?')
|
||||
if not isinstance(new_identifiers, list):
|
||||
raise Exception("hu?")
|
||||
|
||||
raise Exception('hu?')
|
||||
def _text_with_identifier(information, identifier, delete=False, underline=False):
|
||||
if identifier is None:
|
||||
identifier = "{{ __identifier__ }}"
|
||||
|
|
@ -1401,7 +1324,6 @@ def get_path_from_identifiers(
|
|||
identifier = formatter.underline(identifier)
|
||||
identifier = formatter.italic(identifier)
|
||||
return information.replace("{{ identifier }}", identifier, 1)
|
||||
|
||||
if identifier_type == "outside":
|
||||
separator = "and"
|
||||
else:
|
||||
|
|
@ -1442,7 +1364,9 @@ def get_path_from_identifiers(
|
|||
separator=separator,
|
||||
sort=False,
|
||||
)
|
||||
return text.replace("{{ identifier }}", identifiers_text)
|
||||
if identifier_type == "outside":
|
||||
return text.replace(
|
||||
"{{ identifier }}", identifiers_text
|
||||
)
|
||||
if identifier_type == 'outside':
|
||||
return paths
|
||||
return display_list(paths, separator=separator, sort=False)
|
||||
|
|
|
|||
|
|
@ -12,12 +12,5 @@ With useful information.
|
|||
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | The second variable. +
|
||||
Multi line
|
||||
Help
|
||||
With useful information.
|
||||
| **var3** +
|
||||
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | The third variable with spaces. +
|
||||
Multi line with space.
|
||||
|
||||
Help.
|
||||
|
||||
With useful information.
|
||||
|====
|
||||
|
|
@ -1,5 +1,4 @@
|
|||
| Variable | Description |
|
||||
|--------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------|
|
||||
| **<a id="var1" name="var1">var1</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The first variable.<br/>Multi line<br/><br/>Help<br/><br/>With useful information. |
|
||||
| **<a id="var2" name="var2">var2</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The second variable.<br/>Multi line<br/>Help<br/>With useful information. |
|
||||
| **<a id="var3" name="var3">var3</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The third variable with spaces.<br/>Multi line with space.<br/> <br/>Help.<br/><br/>With useful information. |
|
||||
| Variable | Description |
|
||||
|--------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------|
|
||||
| **<a id="var1" name="var1">var1</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The first variable.<br/>Multi line<br/><br/>Help<br/><br/>With useful information. |
|
||||
| **<a id="var2" name="var2">var2</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The second variable.<br/>Multi line<br/>Help<br/>With useful information. |
|
||||
|
|
@ -10,11 +10,6 @@ Help
|
|||
With useful information. </td></tr>
|
||||
<tr><td><b>var2</b><br/><mark><a href='https://rougail.readthedocs.io/en/latest/variable.html#variables-types'>string</a></mark> <mark>basic</mark> <mark>mandatory</mark></td><td>The second variable.<br/>Multi line
|
||||
Help
|
||||
With useful information. </td></tr>
|
||||
<tr><td><b>var3</b><br/><mark><a href='https://rougail.readthedocs.io/en/latest/variable.html#variables-types'>string</a></mark> <mark>basic</mark> <mark>mandatory</mark></td><td>The third variable with spaces.<br/>Multi line with space.
|
||||
|
||||
Help.
|
||||
|
||||
With useful information. </td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -36,24 +36,5 @@
|
|||
"mode": "basic",
|
||||
"type": "variable",
|
||||
"variable_type": "string"
|
||||
},
|
||||
"var3": {
|
||||
"path": "var3",
|
||||
"name": "var3",
|
||||
"description": "The third variable with spaces.",
|
||||
"help": [
|
||||
"Multi line with space.\n \nHelp.\n\nWith useful information."
|
||||
],
|
||||
"properties": [
|
||||
{
|
||||
"type": "property",
|
||||
"name": "mandatory",
|
||||
"ori_name": "mandatory",
|
||||
"access_control": false
|
||||
}
|
||||
],
|
||||
"mode": "basic",
|
||||
"type": "variable",
|
||||
"variable_type": "string"
|
||||
}
|
||||
}
|
||||
|
|
@ -1,5 +1,4 @@
|
|||
| Variable | Description |
|
||||
|--------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------|
|
||||
| **<a id="var1" name="var1">var1</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The first variable.<br/>Multi line<br/><br/>Help<br/><br/>With useful information. |
|
||||
| **<a id="var2" name="var2">var2</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The second variable.<br/>Multi line<br/>Help<br/>With useful information. |
|
||||
| **<a id="var3" name="var3">var3</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The third variable with spaces.<br/>Multi line with space.<br/> <br/>Help.<br/><br/>With useful information. |
|
||||
| Variable | Description |
|
||||
|--------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------|
|
||||
| **<a id="var1" name="var1">var1</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The first variable.<br/>Multi line<br/><br/>Help<br/><br/>With useful information. |
|
||||
| **<a id="var2" name="var2">var2</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The second variable.<br/>Multi line<br/>Help<br/>With useful information. |
|
||||
|
|
@ -12,12 +12,5 @@
|
|||
│ [1;7m string [0m [1;7m basic [0m [1;7m mandatory [0m │ Multi line │
|
||||
│ │ Help │
|
||||
│ │ With useful information. │
|
||||
├───────────────────────────────────────┼──────────────────────────────────────┤
|
||||
│ [1mvar3[0m │ The third variable with spaces. │
|
||||
│ [1;7m string [0m [1;7m basic [0m [1;7m mandatory [0m │ Multi line with space. │
|
||||
│ │ │
|
||||
│ │ Help. │
|
||||
│ │ │
|
||||
│ │ With useful information. │
|
||||
└───────────────────────────────────────┴──────────────────────────────────────┘
|
||||
|
||||
|
|
|
|||
|
|
@ -39,24 +39,3 @@ With useful information. +
|
|||
| **family2.var** +
|
||||
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory`
|
||||
|====
|
||||
|
||||
== The third family with space
|
||||
|
||||
====
|
||||
**🛈 Informations**
|
||||
|
||||
Multi line. +
|
||||
+
|
||||
Help. +
|
||||
With useful information. +
|
||||
**Path**: family3 +
|
||||
`basic`
|
||||
|
||||
====
|
||||
|
||||
[cols="1a,1a"]
|
||||
|====
|
||||
| Variable | Description
|
||||
| **family3.var** +
|
||||
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | A variable.
|
||||
|====
|
||||
|
|
@ -39,24 +39,3 @@
|
|||
| **<a id="family2.var" name="family2.var">family2.var</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` |
|
||||
|
||||
</details>
|
||||
|
||||
<details><summary>The third family with space</summary>
|
||||
|
||||
> [!note] 🛈 Informations
|
||||
> Multi line.
|
||||
>
|
||||
>
|
||||
>
|
||||
> Help.
|
||||
>
|
||||
> With useful information.
|
||||
>
|
||||
> **Path**: family3
|
||||
>
|
||||
> `basic`
|
||||
|
||||
| Variable | Description |
|
||||
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------|
|
||||
| **<a id="family3.var" name="family3.var">family3.var</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. |
|
||||
|
||||
</details>
|
||||
|
|
@ -23,16 +23,3 @@ Multi line.<br/>Help.<br/>With useful information.<br/><b>Path</b>: family2<br/>
|
|||
<tr><td><b>family2.var</b><br/><mark><a href='https://rougail.readthedocs.io/en/latest/variable.html#variables-types'>string</a></mark> <mark>basic</mark> <mark>mandatory</mark></td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
<h1>The third family with space</h1>
|
||||
|
||||
Multi line.<br/><br/>Help.<br/>With useful information.<br/><b>Path</b>: family3<br/><mark>basic</mark>
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Variable </th><th>Description </th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td><b>family3.var</b><br/><mark><a href='https://rougail.readthedocs.io/en/latest/variable.html#variables-types'>string</a></mark> <mark>basic</mark> <mark>mandatory</mark></td><td>A variable. </td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -58,36 +58,5 @@
|
|||
"variable_type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"family3": {
|
||||
"type": "family",
|
||||
"informations": {
|
||||
"path": "family3",
|
||||
"name": "family3",
|
||||
"description": "The third family with space",
|
||||
"help": [
|
||||
"Multi line\n \nHelp\nWith useful information."
|
||||
],
|
||||
"properties": [],
|
||||
"mode": "basic"
|
||||
},
|
||||
"children": {
|
||||
"var": {
|
||||
"path": "family3.var",
|
||||
"name": "var",
|
||||
"description": "A variable.",
|
||||
"properties": [
|
||||
{
|
||||
"type": "property",
|
||||
"name": "mandatory",
|
||||
"ori_name": "mandatory",
|
||||
"access_control": false
|
||||
}
|
||||
],
|
||||
"mode": "basic",
|
||||
"type": "variable",
|
||||
"variable_type": "string"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -27,18 +27,3 @@
|
|||
| Variable |
|
||||
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| **<a id="family2.var" name="family2.var">family2.var</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` |
|
||||
|
||||
# The third family with space
|
||||
|
||||
> [!NOTE]
|
||||
>
|
||||
> Multi line.\
|
||||
> \
|
||||
> Help.\
|
||||
> With useful information.\
|
||||
> **Path**: family3\
|
||||
> `basic`
|
||||
|
||||
| Variable | Description |
|
||||
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------|
|
||||
| **<a id="family3.var" name="family3.var">family3.var</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. |
|
||||
|
|
@ -34,21 +34,3 @@
|
|||
│ [1;7m string [0m [1;7m basic [0m [1;7m mandatory [0m │
|
||||
└──────────────────────────────────────────────────────────────────────────────┘
|
||||
|
||||
[1;4;96mThe third family with space[0m
|
||||
|
||||
[34m▌ [0m[1;34m🛈 Informations[0m
|
||||
[34m▌ [0m
|
||||
[34m▌ [0mMulti line.
|
||||
[34m▌ [0m
|
||||
[34m▌ [0mHelp.
|
||||
[34m▌ [0mWith useful information.
|
||||
[34m▌ [0m[1mPath[0m: family3
|
||||
[34m▌ [0m[1;7m basic [0m
|
||||
|
||||
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
|
||||
┃[1m [0m[1mVariable [0m[1m [0m┃[1m [0m[1mDescription [0m[1m [0m┃
|
||||
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
|
||||
│ [1mfamily3.var[0m │ A variable. │
|
||||
│ [1;7m string [0m [1;7m basic [0m [1;7m mandatory [0m │ │
|
||||
└───────────────────────────────────────┴──────────────────────────────────────┘
|
||||
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@ version: example
|
|||
----
|
||||
|
||||
|
||||
== Example with all modifiable variables
|
||||
== Example with all variables modifiable
|
||||
|
||||
[,yaml]
|
||||
----
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@ version: example
|
|||
|
||||
</details>
|
||||
|
||||
<details><summary>Example with all modifiable variables</summary>
|
||||
<details><summary>Example with all variables modifiable</summary>
|
||||
|
||||
```yaml
|
||||
---
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
<pre>---
|
||||
version: example</pre>
|
||||
|
||||
<h1>Example with all modifiable variables</h1>
|
||||
<h1>Example with all variables modifiable</h1>
|
||||
|
||||
<pre>---
|
||||
version: example</pre>
|
||||
|
|
@ -5,7 +5,7 @@
|
|||
version: example
|
||||
```
|
||||
|
||||
# Example with all modifiable variables
|
||||
# Example with all variables modifiable
|
||||
|
||||
```yaml
|
||||
---
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
[38;2;248;248;242;48;2;39;40;34m---[0m[48;2;39;40;34m [0m
|
||||
[38;2;255;70;137;48;2;39;40;34mversion[0m[38;2;248;248;242;48;2;39;40;34m:[0m[38;2;248;248;242;48;2;39;40;34m [0m[48;2;39;40;34mexample [0m
|
||||
|
||||
[1;4;96mExample with all modifiable variables[0m
|
||||
[1;4;96mExample with all variables modifiable[0m
|
||||
|
||||
[38;2;248;248;242;48;2;39;40;34m---[0m[48;2;39;40;34m [0m
|
||||
[38;2;255;70;137;48;2;39;40;34mversion[0m[38;2;248;248;242;48;2;39;40;34m:[0m[38;2;248;248;242;48;2;39;40;34m [0m[48;2;39;40;34mexample [0m
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@ empty: example
|
|||
----
|
||||
|
||||
|
||||
== Example with all modifiable variables
|
||||
== Example with all variables modifiable
|
||||
|
||||
[,yaml]
|
||||
----
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@ empty: example
|
|||
|
||||
</details>
|
||||
|
||||
<details><summary>Example with all modifiable variables</summary>
|
||||
<details><summary>Example with all variables modifiable</summary>
|
||||
|
||||
```yaml
|
||||
---
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
<pre>---
|
||||
empty: example</pre>
|
||||
|
||||
<h1>Example with all modifiable variables</h1>
|
||||
<h1>Example with all variables modifiable</h1>
|
||||
|
||||
<pre>---
|
||||
empty: example</pre>
|
||||
|
|
@ -5,7 +5,7 @@
|
|||
empty: example
|
||||
```
|
||||
|
||||
# Example with all modifiable variables
|
||||
# Example with all variables modifiable
|
||||
|
||||
```yaml
|
||||
---
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
[38;2;248;248;242;48;2;39;40;34m---[0m[48;2;39;40;34m [0m
|
||||
[38;2;255;70;137;48;2;39;40;34mempty[0m[38;2;248;248;242;48;2;39;40;34m:[0m[38;2;248;248;242;48;2;39;40;34m [0m[48;2;39;40;34mexample [0m
|
||||
|
||||
[1;4;96mExample with all modifiable variables[0m
|
||||
[1;4;96mExample with all variables modifiable[0m
|
||||
|
||||
[38;2;248;248;242;48;2;39;40;34m---[0m[48;2;39;40;34m [0m
|
||||
[38;2;255;70;137;48;2;39;40;34mempty[0m[38;2;248;248;242;48;2;39;40;34m:[0m[38;2;248;248;242;48;2;39;40;34m [0m[48;2;39;40;34mexample [0m
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
== Example with all modifiable variables
|
||||
== Example with all variables modifiable
|
||||
|
||||
[,yaml]
|
||||
----
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
<details><summary>Example with all modifiable variables</summary>
|
||||
<details><summary>Example with all variables modifiable</summary>
|
||||
|
||||
```yaml
|
||||
---
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
<h1>Example with all modifiable variables</h1>
|
||||
<h1>Example with all variables modifiable</h1>
|
||||
|
||||
<pre>---
|
||||
var1: no
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
# Example with all modifiable variables
|
||||
# Example with all variables modifiable
|
||||
|
||||
```yaml
|
||||
---
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
[1;4;96mExample with all modifiable variables[0m
|
||||
[1;4;96mExample with all variables modifiable[0m
|
||||
|
||||
[38;2;248;248;242;48;2;39;40;34m---[0m[48;2;39;40;34m [0m
|
||||
[38;2;255;70;137;48;2;39;40;34mvar1[0m[38;2;248;248;242;48;2;39;40;34m:[0m[38;2;248;248;242;48;2;39;40;34m [0m[48;2;39;40;34mno [0m
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
== Example with all modifiable variables
|
||||
== Example with all variables modifiable
|
||||
|
||||
[,yaml]
|
||||
----
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
<details><summary>Example with all modifiable variables</summary>
|
||||
<details><summary>Example with all variables modifiable</summary>
|
||||
|
||||
```yaml
|
||||
---
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
<h1>Example with all modifiable variables</h1>
|
||||
<h1>Example with all variables modifiable</h1>
|
||||
|
||||
<pre>---
|
||||
var1:
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
# Example with all modifiable variables
|
||||
# Example with all variables modifiable
|
||||
|
||||
```yaml
|
||||
---
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
[1;4;96mExample with all modifiable variables[0m
|
||||
[1;4;96mExample with all variables modifiable[0m
|
||||
|
||||
[38;2;248;248;242;48;2;39;40;34m---[0m[48;2;39;40;34m [0m
|
||||
[38;2;255;70;137;48;2;39;40;34mvar1[0m[38;2;248;248;242;48;2;39;40;34m:[0m[48;2;39;40;34m [0m
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
== Example with all modifiable variables
|
||||
== Example with all variables modifiable
|
||||
|
||||
[,yaml]
|
||||
----
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
<details><summary>Example with all modifiable variables</summary>
|
||||
<details><summary>Example with all variables modifiable</summary>
|
||||
|
||||
```yaml
|
||||
---
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
<h1>Example with all modifiable variables</h1>
|
||||
<h1>Example with all variables modifiable</h1>
|
||||
|
||||
<pre>---
|
||||
var2: a_value</pre>
|
||||
|
|
@ -1,4 +1,4 @@
|
|||
# Example with all modifiable variables
|
||||
# Example with all variables modifiable
|
||||
|
||||
```yaml
|
||||
---
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
[1;4;96mExample with all modifiable variables[0m
|
||||
[1;4;96mExample with all variables modifiable[0m
|
||||
|
||||
[38;2;248;248;242;48;2;39;40;34m---[0m[48;2;39;40;34m [0m
|
||||
[38;2;255;70;137;48;2;39;40;34mvar2[0m[38;2;248;248;242;48;2;39;40;34m:[0m[38;2;248;248;242;48;2;39;40;34m [0m[48;2;39;40;34ma_value [0m
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ var1:
|
|||
----
|
||||
|
||||
|
||||
== Example with all modifiable variables
|
||||
== Example with all variables modifiable
|
||||
|
||||
[,yaml]
|
||||
----
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ var1:
|
|||
|
||||
</details>
|
||||
|
||||
<details><summary>Example with all modifiable variables</summary>
|
||||
<details><summary>Example with all variables modifiable</summary>
|
||||
|
||||
```yaml
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
var1:
|
||||
- example.net</pre>
|
||||
|
||||
<h1>Example with all modifiable variables</h1>
|
||||
<h1>Example with all variables modifiable</h1>
|
||||
|
||||
<pre>---
|
||||
var1:
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@ var1:
|
|||
- example.net
|
||||
```
|
||||
|
||||
# Example with all modifiable variables
|
||||
# Example with all variables modifiable
|
||||
|
||||
```yaml
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
[38;2;255;70;137;48;2;39;40;34mvar1[0m[38;2;248;248;242;48;2;39;40;34m:[0m[48;2;39;40;34m [0m
|
||||
[38;2;248;248;242;48;2;39;40;34m [0m[48;2;39;40;34m-[0m[38;2;248;248;242;48;2;39;40;34m [0m[48;2;39;40;34mexample.net [0m
|
||||
|
||||
[1;4;96mExample with all modifiable variables[0m
|
||||
[1;4;96mExample with all variables modifiable[0m
|
||||
|
||||
[38;2;248;248;242;48;2;39;40;34m---[0m[48;2;39;40;34m [0m
|
||||
[38;2;255;70;137;48;2;39;40;34mvar1[0m[38;2;248;248;242;48;2;39;40;34m:[0m[48;2;39;40;34m [0m
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@ var1: example
|
|||
----
|
||||
|
||||
|
||||
== Example with all modifiable variables
|
||||
== Example with all variables modifiable
|
||||
|
||||
[,yaml]
|
||||
----
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@ var1: example
|
|||
|
||||
</details>
|
||||
|
||||
<details><summary>Example with all modifiable variables</summary>
|
||||
<details><summary>Example with all variables modifiable</summary>
|
||||
|
||||
```yaml
|
||||
---
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
<pre>---
|
||||
var1: example</pre>
|
||||
|
||||
<h1>Example with all modifiable variables</h1>
|
||||
<h1>Example with all variables modifiable</h1>
|
||||
|
||||
<pre>---
|
||||
var1: example
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@
|
|||
var1: example
|
||||
```
|
||||
|
||||
# Example with all modifiable variables
|
||||
# Example with all variables modifiable
|
||||
|
||||
```yaml
|
||||
---
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
[38;2;248;248;242;48;2;39;40;34m---[0m[48;2;39;40;34m [0m
|
||||
[38;2;255;70;137;48;2;39;40;34mvar1[0m[38;2;248;248;242;48;2;39;40;34m:[0m[38;2;248;248;242;48;2;39;40;34m [0m[48;2;39;40;34mexample [0m
|
||||
|
||||
[1;4;96mExample with all modifiable variables[0m
|
||||
[1;4;96mExample with all variables modifiable[0m
|
||||
|
||||
[38;2;248;248;242;48;2;39;40;34m---[0m[48;2;39;40;34m [0m
|
||||
[38;2;255;70;137;48;2;39;40;34mvar1[0m[38;2;248;248;242;48;2;39;40;34m:[0m[38;2;248;248;242;48;2;39;40;34m [0m[48;2;39;40;34mexample [0m
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ var3: example
|
|||
----
|
||||
|
||||
|
||||
== Example with all modifiable variables
|
||||
== Example with all variables modifiable
|
||||
|
||||
[,yaml]
|
||||
----
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ var3: example
|
|||
|
||||
</details>
|
||||
|
||||
<details><summary>Example with all modifiable variables</summary>
|
||||
<details><summary>Example with all variables modifiable</summary>
|
||||
|
||||
```yaml
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
var1: example
|
||||
var3: example</pre>
|
||||
|
||||
<h1>Example with all modifiable variables</h1>
|
||||
<h1>Example with all variables modifiable</h1>
|
||||
|
||||
<pre>---
|
||||
var1: example
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@ var1: example
|
|||
var3: example
|
||||
```
|
||||
|
||||
# Example with all modifiable variables
|
||||
# Example with all variables modifiable
|
||||
|
||||
```yaml
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
[38;2;255;70;137;48;2;39;40;34mvar1[0m[38;2;248;248;242;48;2;39;40;34m:[0m[38;2;248;248;242;48;2;39;40;34m [0m[48;2;39;40;34mexample [0m
|
||||
[38;2;255;70;137;48;2;39;40;34mvar3[0m[38;2;248;248;242;48;2;39;40;34m:[0m[38;2;248;248;242;48;2;39;40;34m [0m[48;2;39;40;34mexample [0m
|
||||
|
||||
[1;4;96mExample with all modifiable variables[0m
|
||||
[1;4;96mExample with all variables modifiable[0m
|
||||
|
||||
[38;2;248;248;242;48;2;39;40;34m---[0m[48;2;39;40;34m [0m
|
||||
[38;2;255;70;137;48;2;39;40;34mvar1[0m[38;2;248;248;242;48;2;39;40;34m:[0m[38;2;248;248;242;48;2;39;40;34m [0m[48;2;39;40;34mexample [0m
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ var1:
|
|||
----
|
||||
|
||||
|
||||
== Example with all modifiable variables
|
||||
== Example with all variables modifiable
|
||||
|
||||
[,yaml]
|
||||
----
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ var1:
|
|||
|
||||
</details>
|
||||
|
||||
<details><summary>Example with all modifiable variables</summary>
|
||||
<details><summary>Example with all variables modifiable</summary>
|
||||
|
||||
```yaml
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
var1:
|
||||
- example.net</pre>
|
||||
|
||||
<h1>Example with all modifiable variables</h1>
|
||||
<h1>Example with all variables modifiable</h1>
|
||||
|
||||
<pre>---
|
||||
var1:
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@ var1:
|
|||
- example.net
|
||||
```
|
||||
|
||||
# Example with all modifiable variables
|
||||
# Example with all variables modifiable
|
||||
|
||||
```yaml
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
[38;2;255;70;137;48;2;39;40;34mvar1[0m[38;2;248;248;242;48;2;39;40;34m:[0m[48;2;39;40;34m [0m
|
||||
[38;2;248;248;242;48;2;39;40;34m [0m[48;2;39;40;34m-[0m[38;2;248;248;242;48;2;39;40;34m [0m[48;2;39;40;34mexample.net [0m
|
||||
|
||||
[1;4;96mExample with all modifiable variables[0m
|
||||
[1;4;96mExample with all variables modifiable[0m
|
||||
|
||||
[38;2;248;248;242;48;2;39;40;34m---[0m[48;2;39;40;34m [0m
|
||||
[38;2;255;70;137;48;2;39;40;34mvar1[0m[38;2;248;248;242;48;2;39;40;34m:[0m[48;2;39;40;34m [0m
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ var2: example
|
|||
----
|
||||
|
||||
|
||||
== Example with all modifiable variables
|
||||
== Example with all variables modifiable
|
||||
|
||||
[,yaml]
|
||||
----
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ var2: example
|
|||
|
||||
</details>
|
||||
|
||||
<details><summary>Example with all modifiable variables</summary>
|
||||
<details><summary>Example with all variables modifiable</summary>
|
||||
|
||||
```yaml
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
var1: example
|
||||
var2: example</pre>
|
||||
|
||||
<h1>Example with all modifiable variables</h1>
|
||||
<h1>Example with all variables modifiable</h1>
|
||||
|
||||
<pre>---
|
||||
var1: example
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@ var1: example
|
|||
var2: example
|
||||
```
|
||||
|
||||
# Example with all modifiable variables
|
||||
# Example with all variables modifiable
|
||||
|
||||
```yaml
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
[38;2;255;70;137;48;2;39;40;34mvar1[0m[38;2;248;248;242;48;2;39;40;34m:[0m[38;2;248;248;242;48;2;39;40;34m [0m[48;2;39;40;34mexample [0m
|
||||
[38;2;255;70;137;48;2;39;40;34mvar2[0m[38;2;248;248;242;48;2;39;40;34m:[0m[38;2;248;248;242;48;2;39;40;34m [0m[48;2;39;40;34mexample [0m
|
||||
|
||||
[1;4;96mExample with all modifiable variables[0m
|
||||
[1;4;96mExample with all variables modifiable[0m
|
||||
|
||||
[38;2;248;248;242;48;2;39;40;34m---[0m[48;2;39;40;34m [0m
|
||||
[38;2;255;70;137;48;2;39;40;34mvar1[0m[38;2;248;248;242;48;2;39;40;34m:[0m[38;2;248;248;242;48;2;39;40;34m [0m[48;2;39;40;34mexample [0m
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
== Example with all modifiable variables
|
||||
== Example with all variables modifiable
|
||||
|
||||
[,yaml]
|
||||
----
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
<details><summary>Example with all modifiable variables</summary>
|
||||
<details><summary>Example with all variables modifiable</summary>
|
||||
|
||||
```yaml
|
||||
---
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
<h1>Example with all modifiable variables</h1>
|
||||
<h1>Example with all variables modifiable</h1>
|
||||
|
||||
<pre>---
|
||||
without_type: non</pre>
|
||||
|
|
@ -1,4 +1,4 @@
|
|||
# Example with all modifiable variables
|
||||
# Example with all variables modifiable
|
||||
|
||||
```yaml
|
||||
---
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
[1;4;96mExample with all modifiable variables[0m
|
||||
[1;4;96mExample with all variables modifiable[0m
|
||||
|
||||
[38;2;248;248;242;48;2;39;40;34m---[0m[48;2;39;40;34m [0m
|
||||
[38;2;255;70;137;48;2;39;40;34mwithout_type[0m[38;2;248;248;242;48;2;39;40;34m:[0m[38;2;248;248;242;48;2;39;40;34m [0m[48;2;39;40;34mnon [0m
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
== Example with all modifiable variables
|
||||
== Example with all variables modifiable
|
||||
|
||||
[,yaml]
|
||||
----
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
<details><summary>Example with all modifiable variables</summary>
|
||||
<details><summary>Example with all variables modifiable</summary>
|
||||
|
||||
```yaml
|
||||
---
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
<h1>Example with all modifiable variables</h1>
|
||||
<h1>Example with all variables modifiable</h1>
|
||||
|
||||
<pre>---
|
||||
var1: true
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
# Example with all modifiable variables
|
||||
# Example with all variables modifiable
|
||||
|
||||
```yaml
|
||||
---
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
[1;4;96mExample with all modifiable variables[0m
|
||||
[1;4;96mExample with all variables modifiable[0m
|
||||
|
||||
[38;2;248;248;242;48;2;39;40;34m---[0m[48;2;39;40;34m [0m
|
||||
[38;2;255;70;137;48;2;39;40;34mvar1[0m[38;2;248;248;242;48;2;39;40;34m:[0m[38;2;248;248;242;48;2;39;40;34m [0m[48;2;39;40;34mtrue [0m
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
== Example with all modifiable variables
|
||||
== Example with all variables modifiable
|
||||
|
||||
[,yaml]
|
||||
----
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
<details><summary>Example with all modifiable variables</summary>
|
||||
<details><summary>Example with all variables modifiable</summary>
|
||||
|
||||
```yaml
|
||||
---
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
<h1>Example with all modifiable variables</h1>
|
||||
<h1>Example with all variables modifiable</h1>
|
||||
|
||||
<pre>---
|
||||
variable: true</pre>
|
||||
|
|
@ -1,4 +1,4 @@
|
|||
# Example with all modifiable variables
|
||||
# Example with all variables modifiable
|
||||
|
||||
```yaml
|
||||
---
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
[1;4;96mExample with all modifiable variables[0m
|
||||
[1;4;96mExample with all variables modifiable[0m
|
||||
|
||||
[38;2;248;248;242;48;2;39;40;34m---[0m[48;2;39;40;34m [0m
|
||||
[38;2;255;70;137;48;2;39;40;34mvariable[0m[38;2;248;248;242;48;2;39;40;34m:[0m[38;2;248;248;242;48;2;39;40;34m [0m[48;2;39;40;34mtrue [0m
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ var2: a
|
|||
----
|
||||
|
||||
|
||||
== Example with all modifiable variables
|
||||
== Example with all variables modifiable
|
||||
|
||||
[,yaml]
|
||||
----
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ var2: a
|
|||
|
||||
</details>
|
||||
|
||||
<details><summary>Example with all modifiable variables</summary>
|
||||
<details><summary>Example with all variables modifiable</summary>
|
||||
|
||||
```yaml
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
var1: a
|
||||
var2: a</pre>
|
||||
|
||||
<h1>Example with all modifiable variables</h1>
|
||||
<h1>Example with all variables modifiable</h1>
|
||||
|
||||
<pre>---
|
||||
var1: a
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@ var1: a
|
|||
var2: a
|
||||
```
|
||||
|
||||
# Example with all modifiable variables
|
||||
# Example with all variables modifiable
|
||||
|
||||
```yaml
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
[38;2;255;70;137;48;2;39;40;34mvar1[0m[38;2;248;248;242;48;2;39;40;34m:[0m[38;2;248;248;242;48;2;39;40;34m [0m[48;2;39;40;34ma [0m
|
||||
[38;2;255;70;137;48;2;39;40;34mvar2[0m[38;2;248;248;242;48;2;39;40;34m:[0m[38;2;248;248;242;48;2;39;40;34m [0m[48;2;39;40;34ma [0m
|
||||
|
||||
[1;4;96mExample with all modifiable variables[0m
|
||||
[1;4;96mExample with all variables modifiable[0m
|
||||
|
||||
[38;2;248;248;242;48;2;39;40;34m---[0m[48;2;39;40;34m [0m
|
||||
[38;2;255;70;137;48;2;39;40;34mvar1[0m[38;2;248;248;242;48;2;39;40;34m:[0m[38;2;248;248;242;48;2;39;40;34m [0m[48;2;39;40;34ma [0m
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
== Example with all modifiable variables
|
||||
== Example with all variables modifiable
|
||||
|
||||
[,yaml]
|
||||
----
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
<details><summary>Example with all modifiable variables</summary>
|
||||
<details><summary>Example with all variables modifiable</summary>
|
||||
|
||||
```yaml
|
||||
---
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
<h1>Example with all modifiable variables</h1>
|
||||
<h1>Example with all variables modifiable</h1>
|
||||
|
||||
<pre>---
|
||||
var: 9</pre>
|
||||
Some files were not shown because too many files have changed in this diff Show more
Loading…
Reference in a new issue