Compare commits
No commits in common. "726c64e23dd81e6bc4170a5b97cb5d276ea74ebc" and "aaf3f951263d9ab57711bf66dfd60de8d6c647fd" have entirely different histories.
726c64e23d
...
aaf3f95126
42 changed files with 24 additions and 902 deletions
|
|
@ -38,6 +38,7 @@ from rougail.object_model import (
|
||||||
CONVERT_OPTION,
|
CONVERT_OPTION,
|
||||||
PROPERTY_ATTRIBUTE,
|
PROPERTY_ATTRIBUTE,
|
||||||
)
|
)
|
||||||
|
from rougail.output_doc.utils import dump
|
||||||
|
|
||||||
|
|
||||||
class Annotator(Walk):
|
class Annotator(Walk):
|
||||||
|
|
@ -59,6 +60,9 @@ class Annotator(Walk):
|
||||||
def populate_family(self) -> None:
|
def populate_family(self) -> None:
|
||||||
"""Set doc, path, ... to family"""
|
"""Set doc, path, ... to family"""
|
||||||
for family in self.get_families():
|
for family in self.get_families():
|
||||||
|
self.objectspace.informations.add(
|
||||||
|
family.path, "dictionaries", family.xmlfiles
|
||||||
|
)
|
||||||
self.convert_variable_property(family)
|
self.convert_variable_property(family)
|
||||||
if family.type != "dynamic":
|
if family.type != "dynamic":
|
||||||
continue
|
continue
|
||||||
|
|
@ -147,6 +151,9 @@ class Annotator(Walk):
|
||||||
)
|
)
|
||||||
if variable.path in self.objectspace.leaders and not default:
|
if variable.path in self.objectspace.leaders and not default:
|
||||||
self.add_examples_values(variable)
|
self.add_examples_values(variable)
|
||||||
|
self.objectspace.informations.add(
|
||||||
|
variable.path, "dictionaries", variable.xmlfiles
|
||||||
|
)
|
||||||
self.convert_variable_property(variable)
|
self.convert_variable_property(variable)
|
||||||
|
|
||||||
def convert_variable_property(
|
def convert_variable_property(
|
||||||
|
|
@ -288,16 +295,18 @@ class Annotator(Walk):
|
||||||
# get comparative value
|
# get comparative value
|
||||||
if values.when_not is not undefined:
|
if values.when_not is not undefined:
|
||||||
value = values.when_not
|
value = values.when_not
|
||||||
condition = "when_not"
|
msg = _('when the variable "{0}" hasn\'t the value "{1}"')
|
||||||
elif values.when is not undefined:
|
else:
|
||||||
|
if values.when is not undefined:
|
||||||
value = values.when
|
value = values.when
|
||||||
condition = "when"
|
|
||||||
else:
|
else:
|
||||||
value = True
|
value = True
|
||||||
condition = "when"
|
msg = _('when the variable "{0}" has the value "{1}"')
|
||||||
|
if not isinstance(value, str):
|
||||||
|
value = dump(value)
|
||||||
|
|
||||||
# set message
|
# set message
|
||||||
values_calculation = (variable_path, value, condition)
|
values_calculation = msg.format(variable_path, value)
|
||||||
else:
|
else:
|
||||||
values_calculation = variable_path
|
values_calculation = variable_path
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -28,7 +28,7 @@ from rougail.object_model import PROPERTY_ATTRIBUTE
|
||||||
|
|
||||||
from .config import OutPuts
|
from .config import OutPuts
|
||||||
from .i18n import _
|
from .i18n import _
|
||||||
from .utils import DocTypes, get_display_path, dump
|
from .utils import DocTypes, get_display_path
|
||||||
from .example import Examples
|
from .example import Examples
|
||||||
|
|
||||||
|
|
||||||
|
|
@ -168,20 +168,6 @@ class RougailOutputDoc(Examples):
|
||||||
]: # chain(["hidden", "disabled"], self.disabled_modes):
|
]: # chain(["hidden", "disabled"], self.disabled_modes):
|
||||||
if hidden_property in properties:
|
if hidden_property in properties:
|
||||||
return True
|
return True
|
||||||
|
|
||||||
calculation = child.information.get(f"{hidden_property}_calculation", None)
|
|
||||||
if calculation and calculation['type'] == 'variable':
|
|
||||||
variable_path, value, condition = calculation["value"]
|
|
||||||
variable = self.conf.forcepermissive.option(variable_path)
|
|
||||||
try:
|
|
||||||
variable_value = variable.value.get()
|
|
||||||
except AttributeError as err:
|
|
||||||
pass
|
|
||||||
else:
|
|
||||||
uncalculated = variable.value.get(uncalculated=True)
|
|
||||||
if not isinstance(uncalculated, Calculation) and self._is_inaccessible_user_data(variable) and (condition == 'when' and value == variable_value or
|
|
||||||
condition == 'when_not' and value != variable_value):
|
|
||||||
return True
|
|
||||||
if not child.isoptiondescription():
|
if not child.isoptiondescription():
|
||||||
for hidden_property in self.disabled_modes:
|
for hidden_property in self.disabled_modes:
|
||||||
if hidden_property in properties:
|
if hidden_property in properties:
|
||||||
|
|
@ -365,7 +351,7 @@ class RougailOutputDoc(Examples):
|
||||||
):
|
):
|
||||||
warning = _('No attribute "description" for "{0}" in {1}').format(
|
warning = _('No attribute "description" for "{0}" in {1}').format(
|
||||||
obj.path(uncalculated=True),
|
obj.path(uncalculated=True),
|
||||||
display_xmlfiles(obj.information.get("ymlfiles")),
|
display_xmlfiles(obj.information.get("dictionaries")),
|
||||||
)
|
)
|
||||||
warn(warning)
|
warn(warning)
|
||||||
else:
|
else:
|
||||||
|
|
@ -512,13 +498,10 @@ class RougailOutputDoc(Examples):
|
||||||
"name": msg,
|
"name": msg,
|
||||||
}
|
}
|
||||||
elif variable.information.get(f"{prop}_calculation", False):
|
elif variable.information.get(f"{prop}_calculation", False):
|
||||||
annotation = self._to_string(variable, prop)
|
|
||||||
if not annotation:
|
|
||||||
continue
|
|
||||||
prop_obj = {
|
prop_obj = {
|
||||||
"type": "property",
|
"type": "property",
|
||||||
"name": msg,
|
"name": msg,
|
||||||
"annotation": annotation,
|
"annotation": self._to_string(variable, prop),
|
||||||
}
|
}
|
||||||
else:
|
else:
|
||||||
continue
|
continue
|
||||||
|
|
@ -564,7 +547,7 @@ class RougailOutputDoc(Examples):
|
||||||
return values
|
return values
|
||||||
return self._calculation_to_string(variable, calculation, prop)
|
return self._calculation_to_string(variable, calculation, prop)
|
||||||
|
|
||||||
def _calculation_to_string(self, child, calculation, prop):
|
def _calculation_to_string(self, variable, calculation, prop):
|
||||||
if "type" not in calculation:
|
if "type" not in calculation:
|
||||||
return calculation["value"]
|
return calculation["value"]
|
||||||
if calculation["type"] == "jinja":
|
if calculation["type"] == "jinja":
|
||||||
|
|
@ -576,32 +559,13 @@ class RougailOutputDoc(Examples):
|
||||||
'"{0}" is a calculation for {1} but has no description in {2}'
|
'"{0}" is a calculation for {1} but has no description in {2}'
|
||||||
).format(
|
).format(
|
||||||
prop,
|
prop,
|
||||||
child.path(),
|
variable.path(),
|
||||||
display_xmlfiles(child.information.get("ymlfiles")),
|
display_xmlfiles(variable.information.get("dictionaries")),
|
||||||
)
|
)
|
||||||
warn(warning)
|
warn(warning)
|
||||||
elif calculation["type"] == "variable":
|
elif calculation["type"] == "variable":
|
||||||
if prop in PROPERTY_ATTRIBUTE:
|
if prop in PROPERTY_ATTRIBUTE:
|
||||||
variable_path, value, condition = calculation["value"]
|
values = calculation["value"]
|
||||||
variable = self.conf.forcepermissive.option(variable_path)
|
|
||||||
try:
|
|
||||||
variable.value.get()
|
|
||||||
except AttributeError as err:
|
|
||||||
pass
|
|
||||||
variable = None
|
|
||||||
else:
|
|
||||||
uncalculated = variable.value.get(uncalculated=True)
|
|
||||||
if not isinstance(uncalculated, Calculation) and self._is_inaccessible_user_data(variable):
|
|
||||||
return None
|
|
||||||
if variable and self._is_inaccessible_user_data(variable):
|
|
||||||
msg = _("depends on an undocumented variable")
|
|
||||||
elif condition == "when_not":
|
|
||||||
msg = _('when the variable "{0}" hasn\'t the value "{1}"')
|
|
||||||
else:
|
|
||||||
msg = _('when the variable "{0}" has the value "{1}"')
|
|
||||||
if not isinstance(value, str):
|
|
||||||
value = dump(value)
|
|
||||||
values = msg.format(variable_path, value)
|
|
||||||
else:
|
else:
|
||||||
if calculation.get("optional", False):
|
if calculation.get("optional", False):
|
||||||
path = calculation["value"]
|
path = calculation["value"]
|
||||||
|
|
|
||||||
|
|
@ -1,11 +0,0 @@
|
||||||
[cols="1a,1a"]
|
|
||||||
|====
|
|
||||||
| Variable | Description
|
|
||||||
|
|
|
||||||
|
|
||||||
**var3** +
|
|
||||||
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` |
|
|
||||||
A third variable. +
|
|
||||||
**Default**: depends on a calculation.
|
|
||||||
|====
|
|
||||||
|
|
||||||
|
|
@ -1,29 +0,0 @@
|
||||||
{
|
|
||||||
"var3": {
|
|
||||||
"type": "variable",
|
|
||||||
"default": "depends on a calculation.",
|
|
||||||
"properties": [
|
|
||||||
{
|
|
||||||
"type": "type",
|
|
||||||
"name": "string"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "mode",
|
|
||||||
"name": "standard"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "property",
|
|
||||||
"name": "mandatory"
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"paths": [
|
|
||||||
"var3"
|
|
||||||
],
|
|
||||||
"names": [
|
|
||||||
"var3"
|
|
||||||
],
|
|
||||||
"descriptions": [
|
|
||||||
"A third variable."
|
|
||||||
]
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
@ -1,4 +0,0 @@
|
||||||
| Variable | Description |
|
|
||||||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
||||||
| **var3**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A third variable.<br/>**Default**: depends on a calculation. |
|
|
||||||
|
|
||||||
|
|
@ -1,6 +0,0 @@
|
||||||
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
|
|
||||||
┃[1m [0m[1mVariable [0m[1m [0m┃[1m [0m[1mDescription [0m[1m [0m┃
|
|
||||||
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
|
|
||||||
│ [1mvar3[0m │ A third variable. │
|
|
||||||
│ [1;7m string [0m [1;7m standard [0m [1;7m mandatory [0m │ [1mDefault[0m: depends on a calculation. │
|
|
||||||
└───────────────────────────────────────┴──────────────────────────────────────┘
|
|
||||||
|
|
@ -1,16 +0,0 @@
|
||||||
[cols="1a,1a"]
|
|
||||||
|====
|
|
||||||
| Variable | Description
|
|
||||||
|
|
|
||||||
|
|
||||||
**var2** +
|
|
||||||
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` |
|
|
||||||
A second variable.
|
|
||||||
|
|
|
||||||
|
|
||||||
**var3** +
|
|
||||||
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` |
|
|
||||||
A third variable. +
|
|
||||||
**Default**: depends on a calculation.
|
|
||||||
|====
|
|
||||||
|
|
||||||
|
|
@ -1,55 +0,0 @@
|
||||||
{
|
|
||||||
"var2": {
|
|
||||||
"type": "variable",
|
|
||||||
"properties": [
|
|
||||||
{
|
|
||||||
"type": "type",
|
|
||||||
"name": "string"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "mode",
|
|
||||||
"name": "basic"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "property",
|
|
||||||
"name": "mandatory"
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"paths": [
|
|
||||||
"var2"
|
|
||||||
],
|
|
||||||
"names": [
|
|
||||||
"var2"
|
|
||||||
],
|
|
||||||
"descriptions": [
|
|
||||||
"A second variable."
|
|
||||||
]
|
|
||||||
},
|
|
||||||
"var3": {
|
|
||||||
"type": "variable",
|
|
||||||
"default": "depends on a calculation.",
|
|
||||||
"properties": [
|
|
||||||
{
|
|
||||||
"type": "type",
|
|
||||||
"name": "string"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "mode",
|
|
||||||
"name": "standard"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "property",
|
|
||||||
"name": "mandatory"
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"paths": [
|
|
||||||
"var3"
|
|
||||||
],
|
|
||||||
"names": [
|
|
||||||
"var3"
|
|
||||||
],
|
|
||||||
"descriptions": [
|
|
||||||
"A third variable."
|
|
||||||
]
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
@ -1,5 +0,0 @@
|
||||||
| Variable | Description |
|
|
||||||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
||||||
| **var2**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A second variable. |
|
|
||||||
| **var3**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A third variable.<br/>**Default**: depends on a calculation. |
|
|
||||||
|
|
||||||
|
|
@ -1,9 +0,0 @@
|
||||||
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
|
|
||||||
┃[1m [0m[1mVariable [0m[1m [0m┃[1m [0m[1mDescription [0m[1m [0m┃
|
|
||||||
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
|
|
||||||
│ [1mvar2[0m │ A second variable. │
|
|
||||||
│ [1;7m string [0m [1;7m basic [0m [1;7m mandatory [0m │ │
|
|
||||||
├───────────────────────────────────────┼──────────────────────────────────────┤
|
|
||||||
│ [1mvar3[0m │ A third variable. │
|
|
||||||
│ [1;7m string [0m [1;7m standard [0m [1;7m mandatory [0m │ [1mDefault[0m: depends on a calculation. │
|
|
||||||
└───────────────────────────────────────┴──────────────────────────────────────┘
|
|
||||||
|
|
@ -1,17 +0,0 @@
|
||||||
[cols="1a,1a"]
|
|
||||||
|====
|
|
||||||
| Variable | Description
|
|
||||||
|
|
|
||||||
|
|
||||||
**var1** +
|
|
||||||
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` |
|
|
||||||
A first variable. +
|
|
||||||
**Default**: value
|
|
||||||
|
|
|
||||||
|
|
||||||
**var3** +
|
|
||||||
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `__disabled__` |
|
|
||||||
A third variable. +
|
|
||||||
**Disabled**: depends on an undocumented variable.
|
|
||||||
|====
|
|
||||||
|
|
||||||
|
|
@ -1,60 +0,0 @@
|
||||||
{
|
|
||||||
"var1": {
|
|
||||||
"type": "variable",
|
|
||||||
"default": "value",
|
|
||||||
"properties": [
|
|
||||||
{
|
|
||||||
"type": "type",
|
|
||||||
"name": "string"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "mode",
|
|
||||||
"name": "standard"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "property",
|
|
||||||
"name": "mandatory"
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"paths": [
|
|
||||||
"var1"
|
|
||||||
],
|
|
||||||
"names": [
|
|
||||||
"var1"
|
|
||||||
],
|
|
||||||
"descriptions": [
|
|
||||||
"A first variable."
|
|
||||||
]
|
|
||||||
},
|
|
||||||
"var3": {
|
|
||||||
"type": "variable",
|
|
||||||
"properties": [
|
|
||||||
{
|
|
||||||
"type": "type",
|
|
||||||
"name": "string"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "mode",
|
|
||||||
"name": "basic"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "property",
|
|
||||||
"name": "mandatory"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "property",
|
|
||||||
"name": "disabled",
|
|
||||||
"annotation": "depends on an undocumented variable."
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"paths": [
|
|
||||||
"var3"
|
|
||||||
],
|
|
||||||
"names": [
|
|
||||||
"var3"
|
|
||||||
],
|
|
||||||
"descriptions": [
|
|
||||||
"A third variable."
|
|
||||||
]
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
@ -1,5 +0,0 @@
|
||||||
| Variable | Description |
|
|
||||||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
||||||
| **var1**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A first variable.<br/>**Default**: value |
|
|
||||||
| **var3**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` *`disabled`* | A third variable.<br/>**Disabled**: depends on an undocumented variable. |
|
|
||||||
|
|
||||||
|
|
@ -1,10 +0,0 @@
|
||||||
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
|
|
||||||
┃[1m [0m[1mVariable [0m[1m [0m┃[1m [0m[1mDescription [0m[1m [0m┃
|
|
||||||
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
|
|
||||||
│ [1mvar1[0m │ A first variable. │
|
|
||||||
│ [1;7m string [0m [1;7m standard [0m [1;7m mandatory [0m │ [1mDefault[0m: value │
|
|
||||||
├───────────────────────────────────────┼──────────────────────────────────────┤
|
|
||||||
│ [1mvar3[0m │ A third variable. │
|
|
||||||
│ [1;7m string [0m [1;7m basic [0m [1;7m mandatory [0m [1;3;7m [0m │ [1mDisabled[0m: depends on an undocumented │
|
|
||||||
│ [1;3;7mdisabled [0m │ variable. │
|
|
||||||
└───────────────────────────────────────┴──────────────────────────────────────┘
|
|
||||||
|
|
@ -1,17 +0,0 @@
|
||||||
[cols="1a,1a"]
|
|
||||||
|====
|
|
||||||
| Variable | Description
|
|
||||||
|
|
|
||||||
|
|
||||||
**var1** +
|
|
||||||
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` |
|
|
||||||
A first variable. +
|
|
||||||
**Default**: value
|
|
||||||
|
|
|
||||||
|
|
||||||
**var3** +
|
|
||||||
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `__disabled__` |
|
|
||||||
A third variable. +
|
|
||||||
**Disabled**: depends on an undocumented variable.
|
|
||||||
|====
|
|
||||||
|
|
||||||
|
|
@ -1,60 +0,0 @@
|
||||||
{
|
|
||||||
"var1": {
|
|
||||||
"type": "variable",
|
|
||||||
"default": "value",
|
|
||||||
"properties": [
|
|
||||||
{
|
|
||||||
"type": "type",
|
|
||||||
"name": "string"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "mode",
|
|
||||||
"name": "standard"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "property",
|
|
||||||
"name": "mandatory"
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"paths": [
|
|
||||||
"var1"
|
|
||||||
],
|
|
||||||
"names": [
|
|
||||||
"var1"
|
|
||||||
],
|
|
||||||
"descriptions": [
|
|
||||||
"A first variable."
|
|
||||||
]
|
|
||||||
},
|
|
||||||
"var3": {
|
|
||||||
"type": "variable",
|
|
||||||
"properties": [
|
|
||||||
{
|
|
||||||
"type": "type",
|
|
||||||
"name": "string"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "mode",
|
|
||||||
"name": "basic"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "property",
|
|
||||||
"name": "mandatory"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "property",
|
|
||||||
"name": "disabled",
|
|
||||||
"annotation": "depends on an undocumented variable."
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"paths": [
|
|
||||||
"var3"
|
|
||||||
],
|
|
||||||
"names": [
|
|
||||||
"var3"
|
|
||||||
],
|
|
||||||
"descriptions": [
|
|
||||||
"A third variable."
|
|
||||||
]
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
@ -1,5 +0,0 @@
|
||||||
| Variable | Description |
|
|
||||||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
||||||
| **var1**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A first variable.<br/>**Default**: value |
|
|
||||||
| **var3**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` *`disabled`* | A third variable.<br/>**Disabled**: depends on an undocumented variable. |
|
|
||||||
|
|
||||||
|
|
@ -1,10 +0,0 @@
|
||||||
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
|
|
||||||
┃[1m [0m[1mVariable [0m[1m [0m┃[1m [0m[1mDescription [0m[1m [0m┃
|
|
||||||
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
|
|
||||||
│ [1mvar1[0m │ A first variable. │
|
|
||||||
│ [1;7m string [0m [1;7m standard [0m [1;7m mandatory [0m │ [1mDefault[0m: value │
|
|
||||||
├───────────────────────────────────────┼──────────────────────────────────────┤
|
|
||||||
│ [1mvar3[0m │ A third variable. │
|
|
||||||
│ [1;7m string [0m [1;7m basic [0m [1;7m mandatory [0m [1;3;7m [0m │ [1mDisabled[0m: depends on an undocumented │
|
|
||||||
│ [1;3;7mdisabled [0m │ variable. │
|
|
||||||
└───────────────────────────────────────┴──────────────────────────────────────┘
|
|
||||||
|
|
@ -1,6 +0,0 @@
|
||||||
# Example with all variables modifiable
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
---
|
|
||||||
var3: value
|
|
||||||
```
|
|
||||||
|
|
@ -1,13 +0,0 @@
|
||||||
# Example with mandatory variables not filled in
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
---
|
|
||||||
var2: example
|
|
||||||
```
|
|
||||||
# Example with all variables modifiable
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
---
|
|
||||||
var2: example
|
|
||||||
var3: value
|
|
||||||
```
|
|
||||||
|
|
@ -1,13 +0,0 @@
|
||||||
# Example with mandatory variables not filled in
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
---
|
|
||||||
var3: example
|
|
||||||
```
|
|
||||||
# Example with all variables modifiable
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
---
|
|
||||||
var1: value
|
|
||||||
var3: example
|
|
||||||
```
|
|
||||||
|
|
@ -1,13 +0,0 @@
|
||||||
# Example with mandatory variables not filled in
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
---
|
|
||||||
var3: example
|
|
||||||
```
|
|
||||||
# Example with all variables modifiable
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
---
|
|
||||||
var1: value
|
|
||||||
var3: example
|
|
||||||
```
|
|
||||||
|
|
@ -1,13 +0,0 @@
|
||||||
== Variables for "Rougail"
|
|
||||||
|
|
||||||
[cols="1a,1a"]
|
|
||||||
|====
|
|
||||||
| Variable | Description
|
|
||||||
|
|
|
||||||
|
|
||||||
**rougail.var3** +
|
|
||||||
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` |
|
|
||||||
A third variable. +
|
|
||||||
**Default**: depends on a calculation.
|
|
||||||
|====
|
|
||||||
|
|
||||||
|
|
@ -1,49 +0,0 @@
|
||||||
{
|
|
||||||
"rougail": {
|
|
||||||
"type": "namespace",
|
|
||||||
"informations": {
|
|
||||||
"paths": [
|
|
||||||
"rougail"
|
|
||||||
],
|
|
||||||
"names": [
|
|
||||||
"rougail"
|
|
||||||
],
|
|
||||||
"description": "Rougail",
|
|
||||||
"properties": [
|
|
||||||
{
|
|
||||||
"type": "mode",
|
|
||||||
"name": "basic"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
},
|
|
||||||
"children": {
|
|
||||||
"rougail.var3": {
|
|
||||||
"type": "variable",
|
|
||||||
"default": "depends on a calculation.",
|
|
||||||
"properties": [
|
|
||||||
{
|
|
||||||
"type": "type",
|
|
||||||
"name": "string"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "mode",
|
|
||||||
"name": "standard"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "property",
|
|
||||||
"name": "mandatory"
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"paths": [
|
|
||||||
"rougail.var3"
|
|
||||||
],
|
|
||||||
"names": [
|
|
||||||
"var3"
|
|
||||||
],
|
|
||||||
"descriptions": [
|
|
||||||
"A third variable."
|
|
||||||
]
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
@ -1,6 +0,0 @@
|
||||||
# Variables for "Rougail"
|
|
||||||
|
|
||||||
| Variable | Description |
|
|
||||||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
||||||
| **rougail.var3**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A third variable.<br/>**Default**: depends on a calculation. |
|
|
||||||
|
|
||||||
|
|
@ -1,11 +0,0 @@
|
||||||
|
|
||||||
|
|
||||||
[1;4;96mVariables for [0m[1;4;96m"Rougail"[0m
|
|
||||||
|
|
||||||
|
|
||||||
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
|
|
||||||
┃[1m [0m[1mVariable [0m[1m [0m┃[1m [0m[1mDescription [0m[1m [0m┃
|
|
||||||
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
|
|
||||||
│ [1mrougail.var3[0m │ A third variable. │
|
|
||||||
│ [1;7m string [0m [1;7m standard [0m [1;7m mandatory [0m │ [1mDefault[0m: depends on a calculation. │
|
|
||||||
└───────────────────────────────────────┴──────────────────────────────────────┘
|
|
||||||
|
|
@ -1,18 +0,0 @@
|
||||||
== Variables for "Rougail"
|
|
||||||
|
|
||||||
[cols="1a,1a"]
|
|
||||||
|====
|
|
||||||
| Variable | Description
|
|
||||||
|
|
|
||||||
|
|
||||||
**rougail.var2** +
|
|
||||||
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` |
|
|
||||||
A second variable.
|
|
||||||
|
|
|
||||||
|
|
||||||
**rougail.var3** +
|
|
||||||
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` |
|
|
||||||
A third variable. +
|
|
||||||
**Default**: depends on a calculation.
|
|
||||||
|====
|
|
||||||
|
|
||||||
|
|
@ -1,75 +0,0 @@
|
||||||
{
|
|
||||||
"rougail": {
|
|
||||||
"type": "namespace",
|
|
||||||
"informations": {
|
|
||||||
"paths": [
|
|
||||||
"rougail"
|
|
||||||
],
|
|
||||||
"names": [
|
|
||||||
"rougail"
|
|
||||||
],
|
|
||||||
"description": "Rougail",
|
|
||||||
"properties": [
|
|
||||||
{
|
|
||||||
"type": "mode",
|
|
||||||
"name": "basic"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
},
|
|
||||||
"children": {
|
|
||||||
"rougail.var2": {
|
|
||||||
"type": "variable",
|
|
||||||
"properties": [
|
|
||||||
{
|
|
||||||
"type": "type",
|
|
||||||
"name": "string"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "mode",
|
|
||||||
"name": "basic"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "property",
|
|
||||||
"name": "mandatory"
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"paths": [
|
|
||||||
"rougail.var2"
|
|
||||||
],
|
|
||||||
"names": [
|
|
||||||
"var2"
|
|
||||||
],
|
|
||||||
"descriptions": [
|
|
||||||
"A second variable."
|
|
||||||
]
|
|
||||||
},
|
|
||||||
"rougail.var3": {
|
|
||||||
"type": "variable",
|
|
||||||
"default": "depends on a calculation.",
|
|
||||||
"properties": [
|
|
||||||
{
|
|
||||||
"type": "type",
|
|
||||||
"name": "string"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "mode",
|
|
||||||
"name": "standard"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "property",
|
|
||||||
"name": "mandatory"
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"paths": [
|
|
||||||
"rougail.var3"
|
|
||||||
],
|
|
||||||
"names": [
|
|
||||||
"var3"
|
|
||||||
],
|
|
||||||
"descriptions": [
|
|
||||||
"A third variable."
|
|
||||||
]
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
@ -1,7 +0,0 @@
|
||||||
# Variables for "Rougail"
|
|
||||||
|
|
||||||
| Variable | Description |
|
|
||||||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
||||||
| **rougail.var2**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A second variable. |
|
|
||||||
| **rougail.var3**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A third variable.<br/>**Default**: depends on a calculation. |
|
|
||||||
|
|
||||||
|
|
@ -1,14 +0,0 @@
|
||||||
|
|
||||||
|
|
||||||
[1;4;96mVariables for [0m[1;4;96m"Rougail"[0m
|
|
||||||
|
|
||||||
|
|
||||||
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
|
|
||||||
┃[1m [0m[1mVariable [0m[1m [0m┃[1m [0m[1mDescription [0m[1m [0m┃
|
|
||||||
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
|
|
||||||
│ [1mrougail.var2[0m │ A second variable. │
|
|
||||||
│ [1;7m string [0m [1;7m basic [0m [1;7m mandatory [0m │ │
|
|
||||||
├───────────────────────────────────────┼──────────────────────────────────────┤
|
|
||||||
│ [1mrougail.var3[0m │ A third variable. │
|
|
||||||
│ [1;7m string [0m [1;7m standard [0m [1;7m mandatory [0m │ [1mDefault[0m: depends on a calculation. │
|
|
||||||
└───────────────────────────────────────┴──────────────────────────────────────┘
|
|
||||||
|
|
@ -1,19 +0,0 @@
|
||||||
== Variables for "Rougail"
|
|
||||||
|
|
||||||
[cols="1a,1a"]
|
|
||||||
|====
|
|
||||||
| Variable | Description
|
|
||||||
|
|
|
||||||
|
|
||||||
**rougail.var1** +
|
|
||||||
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` |
|
|
||||||
A first variable. +
|
|
||||||
**Default**: value
|
|
||||||
|
|
|
||||||
|
|
||||||
**rougail.var3** +
|
|
||||||
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `__disabled__` |
|
|
||||||
A third variable. +
|
|
||||||
**Disabled**: depends on an undocumented variable.
|
|
||||||
|====
|
|
||||||
|
|
||||||
|
|
@ -1,80 +0,0 @@
|
||||||
{
|
|
||||||
"rougail": {
|
|
||||||
"type": "namespace",
|
|
||||||
"informations": {
|
|
||||||
"paths": [
|
|
||||||
"rougail"
|
|
||||||
],
|
|
||||||
"names": [
|
|
||||||
"rougail"
|
|
||||||
],
|
|
||||||
"description": "Rougail",
|
|
||||||
"properties": [
|
|
||||||
{
|
|
||||||
"type": "mode",
|
|
||||||
"name": "basic"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
},
|
|
||||||
"children": {
|
|
||||||
"rougail.var1": {
|
|
||||||
"type": "variable",
|
|
||||||
"default": "value",
|
|
||||||
"properties": [
|
|
||||||
{
|
|
||||||
"type": "type",
|
|
||||||
"name": "string"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "mode",
|
|
||||||
"name": "standard"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "property",
|
|
||||||
"name": "mandatory"
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"paths": [
|
|
||||||
"rougail.var1"
|
|
||||||
],
|
|
||||||
"names": [
|
|
||||||
"var1"
|
|
||||||
],
|
|
||||||
"descriptions": [
|
|
||||||
"A first variable."
|
|
||||||
]
|
|
||||||
},
|
|
||||||
"rougail.var3": {
|
|
||||||
"type": "variable",
|
|
||||||
"properties": [
|
|
||||||
{
|
|
||||||
"type": "type",
|
|
||||||
"name": "string"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "mode",
|
|
||||||
"name": "basic"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "property",
|
|
||||||
"name": "mandatory"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "property",
|
|
||||||
"name": "disabled",
|
|
||||||
"annotation": "depends on an undocumented variable."
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"paths": [
|
|
||||||
"rougail.var3"
|
|
||||||
],
|
|
||||||
"names": [
|
|
||||||
"var3"
|
|
||||||
],
|
|
||||||
"descriptions": [
|
|
||||||
"A third variable."
|
|
||||||
]
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
@ -1,7 +0,0 @@
|
||||||
# Variables for "Rougail"
|
|
||||||
|
|
||||||
| Variable | Description |
|
|
||||||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
||||||
| **rougail.var1**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A first variable.<br/>**Default**: value |
|
|
||||||
| **rougail.var3**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` *`disabled`* | A third variable.<br/>**Disabled**: depends on an undocumented variable. |
|
|
||||||
|
|
||||||
|
|
@ -1,15 +0,0 @@
|
||||||
|
|
||||||
|
|
||||||
[1;4;96mVariables for [0m[1;4;96m"Rougail"[0m
|
|
||||||
|
|
||||||
|
|
||||||
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
|
|
||||||
┃[1m [0m[1mVariable [0m[1m [0m┃[1m [0m[1mDescription [0m[1m [0m┃
|
|
||||||
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
|
|
||||||
│ [1mrougail.var1[0m │ A first variable. │
|
|
||||||
│ [1;7m string [0m [1;7m standard [0m [1;7m mandatory [0m │ [1mDefault[0m: value │
|
|
||||||
├───────────────────────────────────────┼──────────────────────────────────────┤
|
|
||||||
│ [1mrougail.var3[0m │ A third variable. │
|
|
||||||
│ [1;7m string [0m [1;7m basic [0m [1;7m mandatory [0m [1;3;7m [0m │ [1mDisabled[0m: depends on an undocumented │
|
|
||||||
│ [1;3;7mdisabled [0m │ variable. │
|
|
||||||
└───────────────────────────────────────┴──────────────────────────────────────┘
|
|
||||||
|
|
@ -1,19 +0,0 @@
|
||||||
== Variables for "Rougail"
|
|
||||||
|
|
||||||
[cols="1a,1a"]
|
|
||||||
|====
|
|
||||||
| Variable | Description
|
|
||||||
|
|
|
||||||
|
|
||||||
**rougail.var1** +
|
|
||||||
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` |
|
|
||||||
A first variable. +
|
|
||||||
**Default**: value
|
|
||||||
|
|
|
||||||
|
|
||||||
**rougail.var3** +
|
|
||||||
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `__disabled__` |
|
|
||||||
A third variable. +
|
|
||||||
**Disabled**: depends on an undocumented variable.
|
|
||||||
|====
|
|
||||||
|
|
||||||
|
|
@ -1,80 +0,0 @@
|
||||||
{
|
|
||||||
"rougail": {
|
|
||||||
"type": "namespace",
|
|
||||||
"informations": {
|
|
||||||
"paths": [
|
|
||||||
"rougail"
|
|
||||||
],
|
|
||||||
"names": [
|
|
||||||
"rougail"
|
|
||||||
],
|
|
||||||
"description": "Rougail",
|
|
||||||
"properties": [
|
|
||||||
{
|
|
||||||
"type": "mode",
|
|
||||||
"name": "basic"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
},
|
|
||||||
"children": {
|
|
||||||
"rougail.var1": {
|
|
||||||
"type": "variable",
|
|
||||||
"default": "value",
|
|
||||||
"properties": [
|
|
||||||
{
|
|
||||||
"type": "type",
|
|
||||||
"name": "string"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "mode",
|
|
||||||
"name": "standard"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "property",
|
|
||||||
"name": "mandatory"
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"paths": [
|
|
||||||
"rougail.var1"
|
|
||||||
],
|
|
||||||
"names": [
|
|
||||||
"var1"
|
|
||||||
],
|
|
||||||
"descriptions": [
|
|
||||||
"A first variable."
|
|
||||||
]
|
|
||||||
},
|
|
||||||
"rougail.var3": {
|
|
||||||
"type": "variable",
|
|
||||||
"properties": [
|
|
||||||
{
|
|
||||||
"type": "type",
|
|
||||||
"name": "string"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "mode",
|
|
||||||
"name": "basic"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "property",
|
|
||||||
"name": "mandatory"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "property",
|
|
||||||
"name": "disabled",
|
|
||||||
"annotation": "depends on an undocumented variable."
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"paths": [
|
|
||||||
"rougail.var3"
|
|
||||||
],
|
|
||||||
"names": [
|
|
||||||
"var3"
|
|
||||||
],
|
|
||||||
"descriptions": [
|
|
||||||
"A third variable."
|
|
||||||
]
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
@ -1,7 +0,0 @@
|
||||||
# Variables for "Rougail"
|
|
||||||
|
|
||||||
| Variable | Description |
|
|
||||||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
||||||
| **rougail.var1**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A first variable.<br/>**Default**: value |
|
|
||||||
| **rougail.var3**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` *`disabled`* | A third variable.<br/>**Disabled**: depends on an undocumented variable. |
|
|
||||||
|
|
||||||
|
|
@ -1,15 +0,0 @@
|
||||||
|
|
||||||
|
|
||||||
[1;4;96mVariables for [0m[1;4;96m"Rougail"[0m
|
|
||||||
|
|
||||||
|
|
||||||
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
|
|
||||||
┃[1m [0m[1mVariable [0m[1m [0m┃[1m [0m[1mDescription [0m[1m [0m┃
|
|
||||||
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
|
|
||||||
│ [1mrougail.var1[0m │ A first variable. │
|
|
||||||
│ [1;7m string [0m [1;7m standard [0m [1;7m mandatory [0m │ [1mDefault[0m: value │
|
|
||||||
├───────────────────────────────────────┼──────────────────────────────────────┤
|
|
||||||
│ [1mrougail.var3[0m │ A third variable. │
|
|
||||||
│ [1;7m string [0m [1;7m basic [0m [1;7m mandatory [0m [1;3;7m [0m │ [1mDisabled[0m: depends on an undocumented │
|
|
||||||
│ [1;3;7mdisabled [0m │ variable. │
|
|
||||||
└───────────────────────────────────────┴──────────────────────────────────────┘
|
|
||||||
|
|
@ -1,7 +0,0 @@
|
||||||
# Example with all variables modifiable
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
---
|
|
||||||
rougail:
|
|
||||||
var3: value
|
|
||||||
```
|
|
||||||
|
|
@ -1,15 +0,0 @@
|
||||||
# Example with mandatory variables not filled in
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
---
|
|
||||||
rougail:
|
|
||||||
var2: example
|
|
||||||
```
|
|
||||||
# Example with all variables modifiable
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
---
|
|
||||||
rougail:
|
|
||||||
var2: example
|
|
||||||
var3: value
|
|
||||||
```
|
|
||||||
|
|
@ -1,15 +0,0 @@
|
||||||
# Example with mandatory variables not filled in
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
---
|
|
||||||
rougail:
|
|
||||||
var3: example
|
|
||||||
```
|
|
||||||
# Example with all variables modifiable
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
---
|
|
||||||
rougail:
|
|
||||||
var1: value
|
|
||||||
var3: example
|
|
||||||
```
|
|
||||||
|
|
@ -1,15 +0,0 @@
|
||||||
# Example with mandatory variables not filled in
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
---
|
|
||||||
rougail:
|
|
||||||
var3: example
|
|
||||||
```
|
|
||||||
# Example with all variables modifiable
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
---
|
|
||||||
rougail:
|
|
||||||
var1: value
|
|
||||||
var3: example
|
|
||||||
```
|
|
||||||
Loading…
Reference in a new issue