Compare commits
No commits in common. "a0843e08ca79ec97df1b1c64c20c662704f5cd2d" and "cb770dd8d79f0abc620b644ecc9eb76e2f2be752" have entirely different histories.
a0843e08ca
...
cb770dd8d7
28 changed files with 20 additions and 546 deletions
|
|
@ -119,38 +119,27 @@ class RougailOutputDoc(Examples, Changelog):
|
||||||
print(data)
|
print(data)
|
||||||
return ret
|
return ret
|
||||||
|
|
||||||
def load(self):
|
def load(self, reload=False):
|
||||||
self.dynamic_paths = {}
|
self.dynamic_paths = {}
|
||||||
config = self.conf.unrestraint
|
config = self.conf.unrestraint
|
||||||
self.populate_dynamics(config=config)
|
self._populate_dynamics(config, reload)
|
||||||
informations = self.parse_families(config)
|
informations = self.parse_families(config)
|
||||||
if informations is None:
|
if informations is None:
|
||||||
informations = {}
|
informations = {}
|
||||||
self.informations = informations
|
self.informations = informations
|
||||||
|
|
||||||
def populate_dynamics(self, *, config=None, reload=False):
|
def _populate_dynamics(self, family, reload) -> None:
|
||||||
if config is None:
|
for child in family.list():
|
||||||
config = self.conf.unrestraint
|
|
||||||
self._populate_dynamics(config, reload)
|
|
||||||
|
|
||||||
def _populate_dynamics(self, family, reload, uncalculated=False) -> None:
|
|
||||||
def populate(child, uncalculated):
|
|
||||||
if child.isoptiondescription():
|
if child.isoptiondescription():
|
||||||
type_ = "family"
|
type_ = "family"
|
||||||
else:
|
else:
|
||||||
type_ = "variable"
|
type_ = "variable"
|
||||||
if child.isdynamic():
|
if child.isdynamic():
|
||||||
self.populate_dynamic(child, type_, reload, uncalculated)
|
self.populate_dynamic(child, type_, reload)
|
||||||
if not uncalculated and child.isoptiondescription():
|
if child.isoptiondescription():
|
||||||
self._populate_dynamics(child, reload, uncalculated)
|
self._populate_dynamics(child, reload)
|
||||||
for child in family.list(uncalculated=uncalculated):
|
|
||||||
populate(child, uncalculated)
|
|
||||||
if not uncalculated:
|
|
||||||
for child in family.list(uncalculated=True):
|
|
||||||
if child.isdynamic() and child.path(uncalculated=True) not in self.dynamic_paths:
|
|
||||||
populate(family, uncalculated=True)
|
|
||||||
|
|
||||||
def populate_dynamic(self, obj, type_, reload, uncalculated) -> None:
|
def populate_dynamic(self, obj, type_, reload) -> None:
|
||||||
path = obj.path(uncalculated=True)
|
path = obj.path(uncalculated=True)
|
||||||
if path not in self.dynamic_paths:
|
if path not in self.dynamic_paths:
|
||||||
new_name = True
|
new_name = True
|
||||||
|
|
@ -169,8 +158,6 @@ class RougailOutputDoc(Examples, Changelog):
|
||||||
self.dynamic_paths[path]["description"] = self._convert_description(
|
self.dynamic_paths[path]["description"] = self._convert_description(
|
||||||
description, obj, type_, its_a_path=True
|
description, obj, type_, its_a_path=True
|
||||||
)
|
)
|
||||||
if uncalculated:
|
|
||||||
return
|
|
||||||
dynamic_obj = self.dynamic_paths[path]
|
dynamic_obj = self.dynamic_paths[path]
|
||||||
if reload and obj.identifiers() in dynamic_obj["identifiers"]:
|
if reload and obj.identifiers() in dynamic_obj["identifiers"]:
|
||||||
return
|
return
|
||||||
|
|
@ -181,7 +168,7 @@ class RougailOutputDoc(Examples, Changelog):
|
||||||
informations = {}
|
informations = {}
|
||||||
leader = None
|
leader = None
|
||||||
for child in family.list():
|
for child in family.list():
|
||||||
if self.is_inaccessible_user_data(child):
|
if self._is_inaccessible_user_data(child):
|
||||||
continue
|
continue
|
||||||
if child.type(only_self=True) == "symlink":
|
if child.type(only_self=True) == "symlink":
|
||||||
continue
|
continue
|
||||||
|
|
@ -191,7 +178,7 @@ class RougailOutputDoc(Examples, Changelog):
|
||||||
self.parse_family(child, informations)
|
self.parse_family(child, informations)
|
||||||
return informations
|
return informations
|
||||||
|
|
||||||
def is_inaccessible_user_data(self, child):
|
def _is_inaccessible_user_data(self, child):
|
||||||
"""If family is not accessible in read_write mode (to load user_data),
|
"""If family is not accessible in read_write mode (to load user_data),
|
||||||
do not comment this family
|
do not comment this family
|
||||||
"""
|
"""
|
||||||
|
|
@ -212,7 +199,7 @@ class RougailOutputDoc(Examples, Changelog):
|
||||||
uncalculated = variable.value.get(uncalculated=True)
|
uncalculated = variable.value.get(uncalculated=True)
|
||||||
if (
|
if (
|
||||||
not isinstance(uncalculated, Calculation)
|
not isinstance(uncalculated, Calculation)
|
||||||
and self.is_inaccessible_user_data(variable)
|
and self._is_inaccessible_user_data(variable)
|
||||||
and (
|
and (
|
||||||
condition == "when"
|
condition == "when"
|
||||||
and value == variable_value
|
and value == variable_value
|
||||||
|
|
@ -227,11 +214,11 @@ class RougailOutputDoc(Examples, Changelog):
|
||||||
return True
|
return True
|
||||||
return False
|
return False
|
||||||
|
|
||||||
def parse_family(self, family, informations: dict, *, force_injection=False) -> None:
|
def parse_family(self, family, informations: dict) -> None:
|
||||||
path = family.path(uncalculated=True)
|
path = family.path(uncalculated=True)
|
||||||
name = family.name(uncalculated=True)
|
name = family.name(uncalculated=True)
|
||||||
sub_informations = self.parse_families(family)
|
sub_informations = self.parse_families(family)
|
||||||
if not force_injection and not sub_informations:
|
if not sub_informations:
|
||||||
return
|
return
|
||||||
# if self.with_family:
|
# if self.with_family:
|
||||||
family_informations = self._populate_family(
|
family_informations = self._populate_family(
|
||||||
|
|
@ -722,7 +709,7 @@ class RougailOutputDoc(Examples, Changelog):
|
||||||
if prop in HIDDEN_PROPERTIES:
|
if prop in HIDDEN_PROPERTIES:
|
||||||
return False
|
return False
|
||||||
variable = None
|
variable = None
|
||||||
if variable and self.is_inaccessible_user_data(variable):
|
if variable and self._is_inaccessible_user_data(variable):
|
||||||
try:
|
try:
|
||||||
variable_value = self._get_unmodified_default_value(variable)
|
variable_value = self._get_unmodified_default_value(variable)
|
||||||
except VariableCalculationDependencyError:
|
except VariableCalculationDependencyError:
|
||||||
|
|
@ -792,7 +779,7 @@ class RougailOutputDoc(Examples, Changelog):
|
||||||
cpath = calc_path(path, identifiers=identifiers)
|
cpath = calc_path(path, identifiers=identifiers)
|
||||||
if regexp and not regexp.search(cpath):
|
if regexp and not regexp.search(cpath):
|
||||||
continue
|
continue
|
||||||
if self.is_inaccessible_user_data(self.conf.option(cpath)):
|
if self._is_inaccessible_user_data(self.conf.option(cpath)):
|
||||||
if all_is_undocumented is None:
|
if all_is_undocumented is None:
|
||||||
all_is_undocumented = True
|
all_is_undocumented = True
|
||||||
msg = hidden_msg
|
msg = hidden_msg
|
||||||
|
|
@ -819,7 +806,7 @@ class RougailOutputDoc(Examples, Changelog):
|
||||||
except AttributeError as err:
|
except AttributeError as err:
|
||||||
pass
|
pass
|
||||||
else:
|
else:
|
||||||
if not isfollower and self.is_inaccessible_user_data(variable):
|
if not isfollower and self._is_inaccessible_user_data(variable):
|
||||||
try:
|
try:
|
||||||
uncalculated = variable.value.get(uncalculated=True)
|
uncalculated = variable.value.get(uncalculated=True)
|
||||||
except PropertiesOptionError:
|
except PropertiesOptionError:
|
||||||
|
|
@ -858,6 +845,6 @@ class RougailOutputDoc(Examples, Changelog):
|
||||||
return child.value.get()
|
return child.value.get()
|
||||||
if calculation["type"] == "variable":
|
if calculation["type"] == "variable":
|
||||||
variable = self.conf.forcepermissive.option(calculation["value"])
|
variable = self.conf.forcepermissive.option(calculation["value"])
|
||||||
if variable and self.is_inaccessible_user_data(variable):
|
if variable and self._is_inaccessible_user_data(variable):
|
||||||
return self._get_unmodified_default_value(variable)
|
return self._get_unmodified_default_value(variable)
|
||||||
raise VariableCalculationDependencyError()
|
raise VariableCalculationDependencyError()
|
||||||
|
|
|
||||||
|
|
@ -808,11 +808,7 @@ class CommonFormater:
|
||||||
submessage, msg = self.message_to_string(msg, submessage)
|
submessage, msg = self.message_to_string(msg, submessage)
|
||||||
if isinstance(msg, list):
|
if isinstance(msg, list):
|
||||||
if len(msg) == 1:
|
if len(msg) == 1:
|
||||||
submessage, elt = self.message_to_string(msg[0], submessage)
|
msg = calc_path(msg[0], self)
|
||||||
if isinstance(elt, list):
|
|
||||||
submessage += self.list(elt)
|
|
||||||
else:
|
|
||||||
submessage += elt
|
|
||||||
else:
|
else:
|
||||||
lst = []
|
lst = []
|
||||||
for p in msg:
|
for p in msg:
|
||||||
|
|
|
||||||
|
|
@ -1,26 +0,0 @@
|
||||||
== A dynamic family
|
|
||||||
|
|
||||||
This family builds families dynamically.
|
|
||||||
|
|
||||||
|
|
||||||
**dyn__val1__** +
|
|
||||||
**dyn__val2__**
|
|
||||||
|
|
||||||
`basic`
|
|
||||||
|
|
||||||
**Identifiers**: (from an undocumented variable)
|
|
||||||
|
|
||||||
* val1
|
|
||||||
* val2
|
|
||||||
|
|
||||||
[cols="1a,1a"]
|
|
||||||
|====
|
|
||||||
| Variable | Description
|
|
||||||
|
|
|
||||||
|
|
||||||
**dyn__val1__.var** +
|
|
||||||
**dyn__val2__.var** +
|
|
||||||
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` |
|
|
||||||
A dynamic variable.
|
|
||||||
|====
|
|
||||||
|
|
||||||
|
|
@ -1,15 +0,0 @@
|
||||||
<details><summary>A dynamic family</summary>
|
|
||||||
|
|
||||||
This family builds families dynamically.
|
|
||||||
|
|
||||||
>>> [!note] Informations
|
|
||||||
**dyn*val1***<br/>**dyn*val2***<br>`basic`
|
|
||||||
|
|
||||||
**Identifiers**: (from an undocumented variable)<br/>- val1<br/>- val2
|
|
||||||
>>>
|
|
||||||
| Variable | Description |
|
|
||||||
|----------------------------------------------------------------------------------------------------------------------------------------------------|---------------------|
|
|
||||||
| **dyn*val1*.var**<br/>**dyn*val2*.var**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A dynamic variable. |
|
|
||||||
|
|
||||||
</details>
|
|
||||||
|
|
||||||
|
|
@ -1,20 +0,0 @@
|
||||||
<h1>A dynamic family</h1>
|
|
||||||
|
|
||||||
This family builds families dynamically.
|
|
||||||
|
|
||||||
<b>dyn<i>val1</i></b><br/><b>dyn<i>val2</i></b>
|
|
||||||
|
|
||||||
<mark>basic</mark>
|
|
||||||
|
|
||||||
<b>Identifiers</b>: (from an undocumented variable)<ul><li>val1</li>
|
|
||||||
<li>val2</li></ul>
|
|
||||||
|
|
||||||
<table>
|
|
||||||
<thead>
|
|
||||||
<tr><th>Variable </th><th>Description </th></tr>
|
|
||||||
</thead>
|
|
||||||
<tbody>
|
|
||||||
<tr><td><b>dyn<i>val1</i>.var</b><br/><b>dyn<i>val2</i>.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 dynamic variable.</td></tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
|
|
||||||
|
|
@ -1,72 +0,0 @@
|
||||||
{
|
|
||||||
"dyn{{ identifier }}": {
|
|
||||||
"type": "dynamic",
|
|
||||||
"informations": {
|
|
||||||
"names": [
|
|
||||||
"dynval1",
|
|
||||||
"dynval2"
|
|
||||||
],
|
|
||||||
"identifiers": [
|
|
||||||
[
|
|
||||||
"val1"
|
|
||||||
],
|
|
||||||
[
|
|
||||||
"val2"
|
|
||||||
]
|
|
||||||
],
|
|
||||||
"path": "dyn{{ identifier }}",
|
|
||||||
"description": "A dynamic family",
|
|
||||||
"properties": [
|
|
||||||
{
|
|
||||||
"type": "mode",
|
|
||||||
"name": "basic"
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"identifier": [
|
|
||||||
{
|
|
||||||
"submessage": "(from an undocumented variable)",
|
|
||||||
"values": [
|
|
||||||
"val1",
|
|
||||||
"val2"
|
|
||||||
]
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"help": [
|
|
||||||
"This family builds families dynamically."
|
|
||||||
]
|
|
||||||
},
|
|
||||||
"children": {
|
|
||||||
"var": {
|
|
||||||
"names": [
|
|
||||||
"var",
|
|
||||||
"var"
|
|
||||||
],
|
|
||||||
"identifiers": [
|
|
||||||
[
|
|
||||||
"val1"
|
|
||||||
],
|
|
||||||
[
|
|
||||||
"val2"
|
|
||||||
]
|
|
||||||
],
|
|
||||||
"path": "dyn{{ identifier }}.var",
|
|
||||||
"description": "A dynamic variable.",
|
|
||||||
"type": "variable",
|
|
||||||
"properties": [
|
|
||||||
{
|
|
||||||
"type": "type",
|
|
||||||
"name": "string"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "mode",
|
|
||||||
"name": "basic"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "property",
|
|
||||||
"name": "mandatory"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
@ -1,14 +0,0 @@
|
||||||
# A dynamic family
|
|
||||||
|
|
||||||
This family builds families dynamically.
|
|
||||||
|
|
||||||
**dyn*val1***<br/>**dyn*val2***
|
|
||||||
|
|
||||||
`basic`
|
|
||||||
|
|
||||||
**Identifiers**: (from an undocumented variable)<br/>- val1<br/>- val2
|
|
||||||
|
|
||||||
| Variable | Description |
|
|
||||||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
||||||
| **dyn*val1*.var**<br/>**dyn*val2*.var**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A dynamic variable. |
|
|
||||||
|
|
||||||
|
|
@ -1,30 +0,0 @@
|
||||||
|
|
||||||
|
|
||||||
[1;4;96mA dynamic family[0m
|
|
||||||
|
|
||||||
|
|
||||||
This family builds families dynamically.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
[1mdyn[0m[1;3mval1[0m
|
|
||||||
[1mdyn[0m[1;3mval2[0m
|
|
||||||
|
|
||||||
|
|
||||||
[1;7m basic [0m
|
|
||||||
|
|
||||||
|
|
||||||
[1mIdentifiers[0m: [1m([0mfrom an undocumented variable[1m)[0m
|
|
||||||
- val1
|
|
||||||
- val2
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
|
|
||||||
┃[1m [0m[1mVariable [0m[1m [0m┃[1m [0m[1mDescription [0m[1m [0m┃
|
|
||||||
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
|
|
||||||
│ [1mdyn[0m[1;3mval1[0m[1m.var[0m │ A dynamic variable. │
|
|
||||||
│ [1mdyn[0m[1;3mval2[0m[1m.var[0m │ │
|
|
||||||
│ [1;7m string [0m [1;7m basic [0m [1;7m mandatory [0m │ │
|
|
||||||
└───────────────────────────────────────┴──────────────────────────────────────┘
|
|
||||||
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
[]
|
|
||||||
|
|
@ -1,18 +0,0 @@
|
||||||
# Example with mandatory variables not filled in
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
---
|
|
||||||
dynval1:
|
|
||||||
var: example
|
|
||||||
dynval2:
|
|
||||||
var: example
|
|
||||||
```
|
|
||||||
# Example with all variables modifiable
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
---
|
|
||||||
dynval1:
|
|
||||||
var: example
|
|
||||||
dynval2:
|
|
||||||
var: example
|
|
||||||
```
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
[]
|
|
||||||
|
|
@ -1,32 +0,0 @@
|
||||||
== Variables for "Rougail"
|
|
||||||
|
|
||||||
**rougail**
|
|
||||||
|
|
||||||
`basic`
|
|
||||||
|
|
||||||
=== A dynamic family
|
|
||||||
|
|
||||||
This family builds families dynamically.
|
|
||||||
|
|
||||||
|
|
||||||
**rougail.dyn__val1__** +
|
|
||||||
**rougail.dyn__val2__**
|
|
||||||
|
|
||||||
`basic`
|
|
||||||
|
|
||||||
**Identifiers**: (from an undocumented variable)
|
|
||||||
|
|
||||||
* val1
|
|
||||||
* val2
|
|
||||||
|
|
||||||
[cols="1a,1a"]
|
|
||||||
|====
|
|
||||||
| Variable | Description
|
|
||||||
|
|
|
||||||
|
|
||||||
**rougail.dyn__val1__.var** +
|
|
||||||
**rougail.dyn__val2__.var** +
|
|
||||||
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` |
|
|
||||||
A dynamic variable.
|
|
||||||
|====
|
|
||||||
|
|
||||||
|
|
@ -1,13 +0,0 @@
|
||||||
== New variable
|
|
||||||
|
|
||||||
[cols="1a,1a"]
|
|
||||||
|====
|
|
||||||
| Variable | Description
|
|
||||||
|
|
|
||||||
|
|
||||||
**rougail.dyn__val1__.var** +
|
|
||||||
**rougail.dyn__val2__.var** +
|
|
||||||
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` |
|
|
||||||
A dynamic variable.
|
|
||||||
|====
|
|
||||||
|
|
||||||
|
|
@ -1,6 +0,0 @@
|
||||||
<details><summary>New variable</summary>
|
|
||||||
|
|
||||||
| Variable | Description |
|
|
||||||
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------|
|
|
||||||
| **rougail.dyn*val1*.var**<br/>**rougail.dyn*val2*.var**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A dynamic variable. |
|
|
||||||
|
|
||||||
|
|
@ -1,11 +0,0 @@
|
||||||
<h1>New variable</h1>
|
|
||||||
|
|
||||||
<table>
|
|
||||||
<thead>
|
|
||||||
<tr><th>Variable </th><th>Description </th></tr>
|
|
||||||
</thead>
|
|
||||||
<tbody>
|
|
||||||
<tr><td><b>rougail.dyn<i>val1</i>.var</b><br/><b>rougail.dyn<i>val2</i>.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 dynamic variable.</td></tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
|
|
||||||
|
|
@ -1,6 +0,0 @@
|
||||||
# New variable
|
|
||||||
|
|
||||||
| Variable | Description |
|
|
||||||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
||||||
| **rougail.dyn*val1*.var**<br/>**rougail.dyn*val2*.var**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A dynamic variable. |
|
|
||||||
|
|
||||||
|
|
@ -1,12 +0,0 @@
|
||||||
|
|
||||||
|
|
||||||
[1;4;96mNew variable[0m
|
|
||||||
|
|
||||||
|
|
||||||
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
|
|
||||||
┃[1m [0m[1mVariable [0m[1m [0m┃[1m [0m[1mDescription [0m[1m [0m┃
|
|
||||||
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
|
|
||||||
│ [1mrougail.dyn[0m[1;3mval1[0m[1m.var[0m │ A dynamic variable. │
|
|
||||||
│ [1mrougail.dyn[0m[1;3mval2[0m[1m.var[0m │ │
|
|
||||||
│ [1;7m string [0m [1;7m basic [0m [1;7m mandatory [0m │ │
|
|
||||||
└───────────────────────────────────────┴──────────────────────────────────────┘
|
|
||||||
|
|
@ -1,24 +0,0 @@
|
||||||
<details><summary>Rougail</summary>
|
|
||||||
|
|
||||||
>>> [!note] Informations
|
|
||||||
**rougail**<br>`basic`
|
|
||||||
|
|
||||||
|
|
||||||
>>>
|
|
||||||
<details><summary>A dynamic family</summary>
|
|
||||||
|
|
||||||
This family builds families dynamically.
|
|
||||||
|
|
||||||
>>> [!note] Informations
|
|
||||||
**rougail.dyn*val1***<br/>**rougail.dyn*val2***<br>`basic`
|
|
||||||
|
|
||||||
**Identifiers**: (from an undocumented variable)<br/>- val1<br/>- val2
|
|
||||||
>>>
|
|
||||||
| Variable | Description |
|
|
||||||
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------|
|
|
||||||
| **rougail.dyn*val1*.var**<br/>**rougail.dyn*val2*.var**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A dynamic variable. |
|
|
||||||
|
|
||||||
</details>
|
|
||||||
|
|
||||||
</details>
|
|
||||||
|
|
||||||
|
|
@ -1,26 +0,0 @@
|
||||||
<h1>Variables for "Rougail"</h1>
|
|
||||||
|
|
||||||
<b>rougail</b>
|
|
||||||
|
|
||||||
<mark>basic</mark>
|
|
||||||
|
|
||||||
<h2>A dynamic family</h2>
|
|
||||||
|
|
||||||
This family builds families dynamically.
|
|
||||||
|
|
||||||
<b>rougail.dyn<i>val1</i></b><br/><b>rougail.dyn<i>val2</i></b>
|
|
||||||
|
|
||||||
<mark>basic</mark>
|
|
||||||
|
|
||||||
<b>Identifiers</b>: (from an undocumented variable)<ul><li>val1</li>
|
|
||||||
<li>val2</li></ul>
|
|
||||||
|
|
||||||
<table>
|
|
||||||
<thead>
|
|
||||||
<tr><th>Variable </th><th>Description </th></tr>
|
|
||||||
</thead>
|
|
||||||
<tbody>
|
|
||||||
<tr><td><b>rougail.dyn<i>val1</i>.var</b><br/><b>rougail.dyn<i>val2</i>.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 dynamic variable.</td></tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
|
|
||||||
|
|
@ -1,90 +0,0 @@
|
||||||
{
|
|
||||||
"rougail": {
|
|
||||||
"type": "namespace",
|
|
||||||
"informations": {
|
|
||||||
"path": "rougail",
|
|
||||||
"names": [
|
|
||||||
"rougail"
|
|
||||||
],
|
|
||||||
"description": "Rougail",
|
|
||||||
"properties": [
|
|
||||||
{
|
|
||||||
"type": "mode",
|
|
||||||
"name": "basic"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
},
|
|
||||||
"children": {
|
|
||||||
"dyn{{ identifier }}": {
|
|
||||||
"type": "dynamic",
|
|
||||||
"informations": {
|
|
||||||
"names": [
|
|
||||||
"dynval1",
|
|
||||||
"dynval2"
|
|
||||||
],
|
|
||||||
"identifiers": [
|
|
||||||
[
|
|
||||||
"val1"
|
|
||||||
],
|
|
||||||
[
|
|
||||||
"val2"
|
|
||||||
]
|
|
||||||
],
|
|
||||||
"path": "rougail.dyn{{ identifier }}",
|
|
||||||
"description": "A dynamic family",
|
|
||||||
"properties": [
|
|
||||||
{
|
|
||||||
"type": "mode",
|
|
||||||
"name": "basic"
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"identifier": [
|
|
||||||
{
|
|
||||||
"submessage": "(from an undocumented variable)",
|
|
||||||
"values": [
|
|
||||||
"val1",
|
|
||||||
"val2"
|
|
||||||
]
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"help": [
|
|
||||||
"This family builds families dynamically."
|
|
||||||
]
|
|
||||||
},
|
|
||||||
"children": {
|
|
||||||
"var": {
|
|
||||||
"names": [
|
|
||||||
"var",
|
|
||||||
"var"
|
|
||||||
],
|
|
||||||
"identifiers": [
|
|
||||||
[
|
|
||||||
"val1"
|
|
||||||
],
|
|
||||||
[
|
|
||||||
"val2"
|
|
||||||
]
|
|
||||||
],
|
|
||||||
"path": "rougail.dyn{{ identifier }}.var",
|
|
||||||
"description": "A dynamic variable.",
|
|
||||||
"type": "variable",
|
|
||||||
"properties": [
|
|
||||||
{
|
|
||||||
"type": "type",
|
|
||||||
"name": "string"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "mode",
|
|
||||||
"name": "basic"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "property",
|
|
||||||
"name": "mandatory"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
@ -1,20 +0,0 @@
|
||||||
# Variables for "Rougail"
|
|
||||||
|
|
||||||
**rougail**
|
|
||||||
|
|
||||||
`basic`
|
|
||||||
|
|
||||||
## A dynamic family
|
|
||||||
|
|
||||||
This family builds families dynamically.
|
|
||||||
|
|
||||||
**rougail.dyn*val1***<br/>**rougail.dyn*val2***
|
|
||||||
|
|
||||||
`basic`
|
|
||||||
|
|
||||||
**Identifiers**: (from an undocumented variable)<br/>- val1<br/>- val2
|
|
||||||
|
|
||||||
| Variable | Description |
|
|
||||||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
||||||
| **rougail.dyn*val1*.var**<br/>**rougail.dyn*val2*.var**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A dynamic variable. |
|
|
||||||
|
|
||||||
|
|
@ -1,45 +0,0 @@
|
||||||
|
|
||||||
|
|
||||||
[1;4;96mVariables for [0m[1;4;96m"Rougail"[0m
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
[1mrougail[0m
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
[1;7m basic [0m
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
[1;4;92mA dynamic family[0m
|
|
||||||
|
|
||||||
|
|
||||||
This family builds families dynamically.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
[1mrougail.dyn[0m[1;3mval1[0m
|
|
||||||
[1mrougail.dyn[0m[1;3mval2[0m
|
|
||||||
|
|
||||||
|
|
||||||
[1;7m basic [0m
|
|
||||||
|
|
||||||
|
|
||||||
[1mIdentifiers[0m: [1m([0mfrom an undocumented variable[1m)[0m
|
|
||||||
- val1
|
|
||||||
- val2
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
|
|
||||||
┃[1m [0m[1mVariable [0m[1m [0m┃[1m [0m[1mDescription [0m[1m [0m┃
|
|
||||||
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
|
|
||||||
│ [1mrougail.dyn[0m[1;3mval1[0m[1m.var[0m │ A dynamic variable. │
|
|
||||||
│ [1mrougail.dyn[0m[1;3mval2[0m[1m.var[0m │ │
|
|
||||||
│ [1;7m string [0m [1;7m basic [0m [1;7m mandatory [0m │ │
|
|
||||||
└───────────────────────────────────────┴──────────────────────────────────────┘
|
|
||||||
|
|
||||||
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
[]
|
|
||||||
|
|
@ -1,20 +0,0 @@
|
||||||
# Example with mandatory variables not filled in
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
---
|
|
||||||
rougail:
|
|
||||||
dynval1:
|
|
||||||
var: example
|
|
||||||
dynval2:
|
|
||||||
var: example
|
|
||||||
```
|
|
||||||
# Example with all variables modifiable
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
---
|
|
||||||
rougail:
|
|
||||||
dynval1:
|
|
||||||
var: example
|
|
||||||
dynval2:
|
|
||||||
var: example
|
|
||||||
```
|
|
||||||
|
|
@ -1,4 +0,0 @@
|
||||||
| Variable | Description |
|
|
||||||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
||||||
| **rougail.dyn*val1*.var**<br/>**rougail.dyn*val2*.var**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A dynamic variable. |
|
|
||||||
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
[]
|
|
||||||
|
|
@ -20,7 +20,7 @@ excludes = [
|
||||||
]
|
]
|
||||||
|
|
||||||
test_ok = get_structures_list(excludes)
|
test_ok = get_structures_list(excludes)
|
||||||
#test_ok = [HERE.parent.parent / "rougail-tests" / "structures" / "60_0family_dynamic_source_hidden"]
|
# test_ok = [HERE.parent.parent / "rougail-tests" / "structures" / "40_0leadership_leader_follower"]
|
||||||
|
|
||||||
os.environ['COLUMNS'] = '80'
|
os.environ['COLUMNS'] = '80'
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue