fix: do not document symlink
This commit is contained in:
parent
673e89e5e1
commit
705239141e
52 changed files with 928 additions and 26 deletions
|
|
@ -92,19 +92,15 @@ class RougailOutputDoc(Examples):
|
||||||
|
|
||||||
def run(self) -> str:
|
def run(self) -> str:
|
||||||
"""Print documentation in stdout"""
|
"""Print documentation in stdout"""
|
||||||
return self.gen_doc()
|
|
||||||
|
|
||||||
def print(self) -> None:
|
|
||||||
print(self.run())
|
|
||||||
|
|
||||||
def gen_doc(self):
|
|
||||||
"""Return documentation"""
|
|
||||||
self._tiramisu_to_internal_object()
|
self._tiramisu_to_internal_object()
|
||||||
return_string = self.formater.run(self.informations, self.level)
|
return_string = self.formater.run(self.informations, self.level)
|
||||||
if self.with_example:
|
if self.with_example:
|
||||||
return_string += self.gen_doc_examples()
|
return_string += self.gen_doc_examples()
|
||||||
return return_string
|
return return_string
|
||||||
|
|
||||||
|
def print(self) -> None:
|
||||||
|
print(self.run())
|
||||||
|
|
||||||
def _tiramisu_to_internal_object(self):
|
def _tiramisu_to_internal_object(self):
|
||||||
config = self.conf.unrestraint
|
config = self.conf.unrestraint
|
||||||
self._populate_dynamics(config)
|
self._populate_dynamics(config)
|
||||||
|
|
@ -148,6 +144,8 @@ class RougailOutputDoc(Examples):
|
||||||
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(detect_symlink=True) == 'symlink':
|
||||||
|
continue
|
||||||
name = child.name(uncalculated=True)
|
name = child.name(uncalculated=True)
|
||||||
path = child.path(uncalculated=True)
|
path = child.path(uncalculated=True)
|
||||||
if not child.isoptiondescription():
|
if not child.isoptiondescription():
|
||||||
|
|
|
||||||
12
tests/cmdline.adoc
Normal file
12
tests/cmdline.adoc
Normal file
|
|
@ -0,0 +1,12 @@
|
||||||
|
== Variables
|
||||||
|
|
||||||
|
[cols="1a,1a"]
|
||||||
|
|====
|
||||||
|
| Variable | Description
|
||||||
|
|
|
||||||
|
|
||||||
|
**var1** +
|
||||||
|
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `mandatory` |
|
||||||
|
My var1.
|
||||||
|
|====
|
||||||
|
|
||||||
60
tests/cmdline/00_file.yml
Normal file
60
tests/cmdline/00_file.yml
Normal file
|
|
@ -0,0 +1,60 @@
|
||||||
|
---
|
||||||
|
version: 1.1
|
||||||
|
|
||||||
|
var1:
|
||||||
|
description: my var1
|
||||||
|
alternative_name: v
|
||||||
|
|
||||||
|
var2:
|
||||||
|
description: my var2
|
||||||
|
default:
|
||||||
|
jinja: |
|
||||||
|
{{ a.unknown.variable }}
|
||||||
|
description: var calculated
|
||||||
|
|
||||||
|
var3:
|
||||||
|
description: my var3
|
||||||
|
hidden:
|
||||||
|
jinja: |
|
||||||
|
{% if a.unknown.variable == 'value' %}
|
||||||
|
it's hidden
|
||||||
|
{% endif %}
|
||||||
|
description: var could be hidden
|
||||||
|
|
||||||
|
var4:
|
||||||
|
description: my var4
|
||||||
|
hidden:
|
||||||
|
variable: a.unknown.variable
|
||||||
|
when: 'value'
|
||||||
|
|
||||||
|
var5:
|
||||||
|
description: my var5
|
||||||
|
default:
|
||||||
|
type: information
|
||||||
|
information: info
|
||||||
|
variable: a.unknown.variable
|
||||||
|
|
||||||
|
var6:
|
||||||
|
description: my var6
|
||||||
|
choices:
|
||||||
|
variable: a.unknown.variable
|
||||||
|
|
||||||
|
var7:
|
||||||
|
description: my var7
|
||||||
|
choices:
|
||||||
|
- variable: a.unknown.variable1
|
||||||
|
- variable: a.unknown.variable2
|
||||||
|
|
||||||
|
var8:
|
||||||
|
description: my var8
|
||||||
|
choices:
|
||||||
|
jinja: |
|
||||||
|
a.unknown.variable
|
||||||
|
description: the a.unknown.variable values
|
||||||
|
|
||||||
|
"var{{ identifier }}":
|
||||||
|
description: my var6
|
||||||
|
dynamic:
|
||||||
|
variable: a.unknown.variable
|
||||||
|
var:
|
||||||
|
description: a variable
|
||||||
|
|
@ -0,0 +1,18 @@
|
||||||
|
== Variables
|
||||||
|
|
||||||
|
[cols="1a,1a"]
|
||||||
|
|====
|
||||||
|
| Variable | Description
|
||||||
|
|
|
||||||
|
|
||||||
|
**var1** +
|
||||||
|
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` |
|
||||||
|
A first variable.
|
||||||
|
|
|
||||||
|
|
||||||
|
**var2** +
|
||||||
|
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` |
|
||||||
|
A second variable. +
|
||||||
|
**Default**: the value of the information "test_information" of the variable "var1".
|
||||||
|
|====
|
||||||
|
|
||||||
|
|
@ -0,0 +1 @@
|
||||||
|
{"var1": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["var1"], "names": ["var1"], "descriptions": ["A first variable."]}, "var2": {"type": "variable", "default": "the value of the information \"test_information\" of the variable \"var1\".", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["var2"], "names": ["var2"], "descriptions": ["A second variable."]}}
|
||||||
|
|
@ -0,0 +1,11 @@
|
||||||
|
---
|
||||||
|
gitea: none
|
||||||
|
include_toc: true
|
||||||
|
---
|
||||||
|
# Variables
|
||||||
|
|
||||||
|
| Variable | Description |
|
||||||
|
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
|
| **var1**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A first variable. |
|
||||||
|
| **var2**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second variable.<br/>**Default**: the value of the information "test_information" of the variable "var1". |
|
||||||
|
|
||||||
|
|
@ -0,0 +1,18 @@
|
||||||
|
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
|
||||||
|
┃ [1mVariables[0m ┃
|
||||||
|
┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
[1m [0m[1mVariable [0m[1m [0m [1m [0m[1mDescription [0m[1m [0m
|
||||||
|
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
||||||
|
[1mvar1[0m
|
||||||
|
[1;36;40mstring[0m [1;36;40mbasic[0m [1;36;40mmandatory[0m A first variable.
|
||||||
|
[1mvar2[0m
|
||||||
|
[1;36;40mstring[0m [1;36;40mstandard[0m [1;36;40mmandatory[0m A second variable.
|
||||||
|
[1mDefault[0m: the value of the information
|
||||||
|
"test_information" of the variable
|
||||||
|
"var1".
|
||||||
|
|
||||||
|
|
@ -16,7 +16,7 @@ The second variable.
|
||||||
|
|
|
|
||||||
|
|
||||||
**var3** +
|
**var3** +
|
||||||
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` |
|
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` |
|
||||||
The third variable.
|
The third variable.
|
||||||
|
|
|
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1 +1 @@
|
||||||
{"var1": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var1"], "names": ["var1"], "descriptions": ["The first variable."], "multiple": true}, "var2": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var2"], "names": ["var2"], "descriptions": ["The second variable."], "multiple": true}, "var3": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["var3"], "names": ["var3"], "descriptions": ["The third variable."]}, "var4": {"type": "variable", "default": ["value"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var4"], "names": ["var4"], "descriptions": ["The forth variable."], "multiple": true}, "var5": {"type": "variable", "default": ["value"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var5"], "names": ["var5"], "descriptions": ["The fifth variable."], "multiple": true}, "var6": {"type": "variable", "default": ["value"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var6"], "names": ["var6"], "descriptions": ["The sixth variable."], "multiple": true}, "var7": {"type": "variable", "default": ["value"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var7"], "names": ["var7"], "descriptions": ["The seventh variable."], "multiple": true}, "var8": {"type": "variable", "default": ["value"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var8"], "names": ["var8"], "descriptions": ["The eighth variable."], "multiple": true}}
|
{"var1": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var1"], "names": ["var1"], "descriptions": ["The first variable."], "multiple": true}, "var2": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var2"], "names": ["var2"], "descriptions": ["The second variable."], "multiple": true}, "var3": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var3"], "names": ["var3"], "descriptions": ["The third variable."], "multiple": true}, "var4": {"type": "variable", "default": ["value"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var4"], "names": ["var4"], "descriptions": ["The forth variable."], "multiple": true}, "var5": {"type": "variable", "default": ["value"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var5"], "names": ["var5"], "descriptions": ["The fifth variable."], "multiple": true}, "var6": {"type": "variable", "default": ["value"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var6"], "names": ["var6"], "descriptions": ["The sixth variable."], "multiple": true}, "var7": {"type": "variable", "default": ["value"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var7"], "names": ["var7"], "descriptions": ["The seventh variable."], "multiple": true}, "var8": {"type": "variable", "default": ["value"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var8"], "names": ["var8"], "descriptions": ["The eighth variable."], "multiple": true}}
|
||||||
|
|
@ -8,7 +8,7 @@ include_toc: true
|
||||||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
| **var1**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | The first variable. |
|
| **var1**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | The first variable. |
|
||||||
| **var2**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | The second variable. |
|
| **var2**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | The second variable. |
|
||||||
| **var3**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The third variable. |
|
| **var3**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | The third variable. |
|
||||||
| **var4**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The forth variable.<br/>**Default**: value |
|
| **var4**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The forth variable.<br/>**Default**: value |
|
||||||
| **var5**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The fifth variable.<br/>**Default**: value |
|
| **var5**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The fifth variable.<br/>**Default**: value |
|
||||||
| **var6**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The sixth variable.<br/>**Default**: value |
|
| **var6**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The sixth variable.<br/>**Default**: value |
|
||||||
|
|
|
||||||
|
|
@ -25,7 +25,8 @@
|
||||||
[1;36;40mstring[0m [1;36;40mbasic[0m [1;36;40mmandatory[0m [1;36;40munique[0m The second variable.
|
[1;36;40mstring[0m [1;36;40mbasic[0m [1;36;40mmandatory[0m [1;36;40munique[0m The second variable.
|
||||||
[1;36;40mmultiple[0m
|
[1;36;40mmultiple[0m
|
||||||
[1mvar3[0m
|
[1mvar3[0m
|
||||||
[1;36;40mstring[0m [1;36;40mbasic[0m [1;36;40mmandatory[0m The third variable.
|
[1;36;40mstring[0m [1;36;40mbasic[0m [1;36;40mmandatory[0m [1;36;40munique[0m The third variable.
|
||||||
|
[1;36;40mmultiple[0m
|
||||||
[1mvar4[0m
|
[1mvar4[0m
|
||||||
[1;36;40mstring[0m [1;36;40mstandard[0m [1;36;40mmandatory[0m [1;36;40munique[0m The forth variable.
|
[1;36;40mstring[0m [1;36;40mstandard[0m [1;36;40mmandatory[0m [1;36;40munique[0m The forth variable.
|
||||||
[1;36;40mmultiple[0m
|
[1;36;40mmultiple[0m
|
||||||
|
|
|
||||||
0
tests/results/test/16_6exists_family.adoc
Normal file
0
tests/results/test/16_6exists_family.adoc
Normal file
1
tests/results/test/16_6exists_family.json
Normal file
1
tests/results/test/16_6exists_family.json
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
{}
|
||||||
4
tests/results/test/16_6exists_family.md
Normal file
4
tests/results/test/16_6exists_family.md
Normal file
|
|
@ -0,0 +1,4 @@
|
||||||
|
---
|
||||||
|
gitea: none
|
||||||
|
include_toc: true
|
||||||
|
---
|
||||||
0
tests/results/test/16_6exists_family.sh
Normal file
0
tests/results/test/16_6exists_family.sh
Normal file
86
tests/results/test/20_9family_absolute.adoc
Normal file
86
tests/results/test/20_9family_absolute.adoc
Normal file
|
|
@ -0,0 +1,86 @@
|
||||||
|
== Variables
|
||||||
|
|
||||||
|
[cols="1a,1a"]
|
||||||
|
|====
|
||||||
|
| Variable | Description
|
||||||
|
|
|
||||||
|
|
||||||
|
**var1** +
|
||||||
|
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` |
|
||||||
|
First variable.
|
||||||
|
|====
|
||||||
|
|
||||||
|
=== a family
|
||||||
|
|
||||||
|
`basic`
|
||||||
|
|
||||||
|
[cols="1a,1a"]
|
||||||
|
|====
|
||||||
|
| Variable | Description
|
||||||
|
|
|
||||||
|
|
||||||
|
**family.var2** +
|
||||||
|
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` |
|
||||||
|
A second variable. +
|
||||||
|
**Example**: string6
|
||||||
|
|====
|
||||||
|
|
||||||
|
==== a sub family
|
||||||
|
|
||||||
|
`standard`
|
||||||
|
|
||||||
|
[cols="1a,1a"]
|
||||||
|
|====
|
||||||
|
| Variable | Description
|
||||||
|
|
|
||||||
|
|
||||||
|
**family.subfamily.variable** +
|
||||||
|
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` |
|
||||||
|
Third variable. +
|
||||||
|
**Default**:
|
||||||
|
|
||||||
|
* the value of the variable "var1".
|
||||||
|
* the value of the variable "family.var2".
|
||||||
|
|====
|
||||||
|
|
||||||
|
=== a family
|
||||||
|
|
||||||
|
`standard`
|
||||||
|
|
||||||
|
[cols="1a,1a"]
|
||||||
|
|====
|
||||||
|
| Variable | Description
|
||||||
|
|
|
||||||
|
|
||||||
|
**family2.var2** +
|
||||||
|
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` |
|
||||||
|
A variable2. +
|
||||||
|
**Default**: the value of the variable "family.var2".
|
||||||
|
|
|
||||||
|
|
||||||
|
**family2.var3** +
|
||||||
|
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` |
|
||||||
|
Var3. +
|
||||||
|
**Default**: string4 +
|
||||||
|
**Example**: string5
|
||||||
|
|====
|
||||||
|
|
||||||
|
==== a sub family
|
||||||
|
|
||||||
|
`standard`
|
||||||
|
|
||||||
|
[cols="1a,1a"]
|
||||||
|
|====
|
||||||
|
| Variable | Description
|
||||||
|
|
|
||||||
|
|
||||||
|
**family2.subfamily.variable** +
|
||||||
|
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` |
|
||||||
|
Fourth variable. +
|
||||||
|
**Default**:
|
||||||
|
|
||||||
|
* the value of the variable "var1".
|
||||||
|
* the value of the variable "family.var2".
|
||||||
|
* the value of the variable "family2.var3".
|
||||||
|
|====
|
||||||
|
|
||||||
1
tests/results/test/20_9family_absolute.json
Normal file
1
tests/results/test/20_9family_absolute.json
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
{"var1": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["var1"], "names": ["var1"], "descriptions": ["First variable."]}, "family": {"type": "family", "informations": {"paths": ["family"], "names": ["family"], "description": "a family", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"var2": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["family.var2"], "names": ["var2"], "descriptions": ["A second variable."], "examples": ["string6"]}, "subfamily": {"type": "family", "informations": {"paths": ["family.subfamily"], "names": ["subfamily"], "description": "a sub family", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"variable": {"type": "variable", "default": ["the value of the variable \"var1\".", "the value of the variable \"family.var2\"."], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["family.subfamily.variable"], "names": ["variable"], "descriptions": ["Third variable."], "multiple": true}}}}}, "family2": {"type": "family", "informations": {"paths": ["family2"], "names": ["family2"], "description": "a family", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"var2": {"type": "variable", "default": "the value of the variable \"family.var2\".", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["family2.var2"], "names": ["var2"], "descriptions": ["A variable2."]}, "var3": {"type": "variable", "default": "string4", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["family2.var3"], "names": ["var3"], "examples": ["string5"]}, "subfamily": {"type": "family", "informations": {"paths": ["family2.subfamily"], "names": ["subfamily"], "description": "a sub family", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"variable": {"type": "variable", "default": ["the value of the variable \"var1\".", "the value of the variable \"family.var2\".", "the value of the variable \"family2.var3\"."], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["family2.subfamily.variable"], "names": ["variable"], "descriptions": ["Fourth variable."], "multiple": true}}}}}}
|
||||||
43
tests/results/test/20_9family_absolute.md
Normal file
43
tests/results/test/20_9family_absolute.md
Normal file
|
|
@ -0,0 +1,43 @@
|
||||||
|
---
|
||||||
|
gitea: none
|
||||||
|
include_toc: true
|
||||||
|
---
|
||||||
|
# Variables
|
||||||
|
|
||||||
|
| Variable | Description |
|
||||||
|
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
|
| **var1**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | First variable. |
|
||||||
|
|
||||||
|
## a family
|
||||||
|
|
||||||
|
`basic`
|
||||||
|
|
||||||
|
| Variable | Description |
|
||||||
|
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
|
| **family.var2**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A second variable.<br/>**Example**: string6 |
|
||||||
|
|
||||||
|
### a sub family
|
||||||
|
|
||||||
|
`standard`
|
||||||
|
|
||||||
|
| Variable | Description |
|
||||||
|
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
|
| **family.subfamily.variable**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | Third variable.<br/>**Default**: <br/>- the value of the variable "var1".<br/>- the value of the variable "family.var2". |
|
||||||
|
|
||||||
|
## a family
|
||||||
|
|
||||||
|
`standard`
|
||||||
|
|
||||||
|
| Variable | Description |
|
||||||
|
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
|
| **family2.var2**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable2.<br/>**Default**: the value of the variable "family.var2". |
|
||||||
|
| **family2.var3**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Var3.<br/>**Default**: string4<br/>**Example**: string5 |
|
||||||
|
|
||||||
|
### a sub family
|
||||||
|
|
||||||
|
`standard`
|
||||||
|
|
||||||
|
| Variable | Description |
|
||||||
|
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
|
| **family2.subfamily.variable**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | Fourth variable.<br/>**Default**: <br/>- the value of the variable "var1".<br/>- the value of the variable "family.var2".<br/>- the value of the variable "family2.var3". |
|
||||||
|
|
||||||
88
tests/results/test/20_9family_absolute.sh
Normal file
88
tests/results/test/20_9family_absolute.sh
Normal file
|
|
@ -0,0 +1,88 @@
|
||||||
|
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
|
||||||
|
┃ [1mVariables[0m ┃
|
||||||
|
┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
[1m [0m[1mVariable [0m[1m [0m [1m [0m[1mDescription [0m[1m [0m
|
||||||
|
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
||||||
|
[1mvar1[0m
|
||||||
|
[1;36;40mstring[0m [1;36;40mbasic[0m [1;36;40mmandatory[0m First variable.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
[1;4ma family[0m
|
||||||
|
|
||||||
|
[1;36;40mbasic[0m
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
[1m [0m[1mVariable [0m[1m [0m [1m [0m[1mDescription [0m[1m [0m
|
||||||
|
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
||||||
|
[1mfamily.var2[0m
|
||||||
|
[1;36;40mstring[0m [1;36;40mbasic[0m [1;36;40mmandatory[0m A second variable.
|
||||||
|
[1mExample[0m: string6
|
||||||
|
|
||||||
|
|
||||||
|
[1ma sub family[0m
|
||||||
|
|
||||||
|
[1;36;40mstandard[0m
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
[1m [0m[1mVariable [0m[1m [0m [1m [0m[1mDescription [0m[1m [0m
|
||||||
|
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
||||||
|
[1mfamily.subfamily.variable[0m
|
||||||
|
[1;36;40mstring[0m [1;36;40mstandard[0m [1;36;40mmandatory[0m [1;36;40munique[0m Third variable.
|
||||||
|
[1;36;40mmultiple[0m
|
||||||
|
[1mDefault[0m:
|
||||||
|
|
||||||
|
|
||||||
|
[1;33m • [0mthe value of the variable "var1".
|
||||||
|
[1;33m • [0mthe value of the variable "family.var2".
|
||||||
|
[1;33m [0m|
|
||||||
|
|
||||||
|
|
||||||
|
[1;4ma family[0m
|
||||||
|
|
||||||
|
[1;36;40mstandard[0m
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
[1m [0m[1mVariable [0m[1m [0m [1m [0m[1mDescription [0m[1m [0m
|
||||||
|
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
||||||
|
[1mfamily2.var2[0m
|
||||||
|
[1;36;40mstring[0m [1;36;40mstandard[0m [1;36;40mmandatory[0m A variable2.
|
||||||
|
[1mDefault[0m: the value of the variable
|
||||||
|
"family.var2".
|
||||||
|
[1mfamily2.var3[0m
|
||||||
|
[1;36;40mstring[0m [1;36;40mstandard[0m [1;36;40mmandatory[0m Var3.
|
||||||
|
[1mDefault[0m: string4
|
||||||
|
[1mExample[0m: string5
|
||||||
|
|
||||||
|
|
||||||
|
[1ma sub family[0m
|
||||||
|
|
||||||
|
[1;36;40mstandard[0m
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
[1m [0m[1mVariable [0m[1m [0m [1m [0m[1mDescription [0m[1m [0m
|
||||||
|
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
||||||
|
[1mfamily2.subfamily.variable[0m
|
||||||
|
[1;36;40mstring[0m [1;36;40mstandard[0m [1;36;40mmandatory[0m [1;36;40munique[0m Fourth variable.
|
||||||
|
[1;36;40mmultiple[0m
|
||||||
|
[1mDefault[0m:
|
||||||
|
|
||||||
|
|
||||||
|
[1;33m • [0mthe value of the variable "var1".
|
||||||
|
[1;33m • [0mthe value of the variable "family.var2".
|
||||||
|
[1;33m • [0mthe value of the variable "family2.var3".
|
||||||
|
[1;33m [0m|
|
||||||
|
|
@ -0,0 +1,24 @@
|
||||||
|
---
|
||||||
|
gitea: none
|
||||||
|
include_toc: true
|
||||||
|
---
|
||||||
|
# Variables
|
||||||
|
|
||||||
|
| Variable | Description |
|
||||||
|
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
|
| **var1**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A first variable. |
|
||||||
|
| **var2**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second variable.<br/>**Default**: the value of the information "test_information" of the variable "var1". |
|
||||||
|
|
||||||
|
# Example with mandatory variables not filled in
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
---
|
||||||
|
var1: example
|
||||||
|
```
|
||||||
|
# Example with all variables modifiable
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
---
|
||||||
|
var1: example
|
||||||
|
var2: example
|
||||||
|
```
|
||||||
|
|
@ -8,7 +8,7 @@ include_toc: true
|
||||||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
| **var1**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | The first variable. |
|
| **var1**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | The first variable. |
|
||||||
| **var2**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | The second variable. |
|
| **var2**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | The second variable. |
|
||||||
| **var3**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The third variable. |
|
| **var3**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | The third variable. |
|
||||||
| **var4**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The forth variable.<br/>**Default**: value |
|
| **var4**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The forth variable.<br/>**Default**: value |
|
||||||
| **var5**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The fifth variable.<br/>**Default**: value |
|
| **var5**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The fifth variable.<br/>**Default**: value |
|
||||||
| **var6**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The sixth variable.<br/>**Default**: value |
|
| **var6**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The sixth variable.<br/>**Default**: value |
|
||||||
|
|
@ -23,7 +23,8 @@ var1:
|
||||||
- example
|
- example
|
||||||
var2:
|
var2:
|
||||||
- example
|
- example
|
||||||
var3: example
|
var3:
|
||||||
|
- example
|
||||||
```
|
```
|
||||||
# Example with all variables modifiable
|
# Example with all variables modifiable
|
||||||
|
|
||||||
|
|
@ -33,7 +34,8 @@ var1:
|
||||||
- example
|
- example
|
||||||
var2:
|
var2:
|
||||||
- example
|
- example
|
||||||
var3: example
|
var3:
|
||||||
|
- example
|
||||||
var4:
|
var4:
|
||||||
- value
|
- value
|
||||||
var5:
|
var5:
|
||||||
|
|
|
||||||
4
tests/results/test_examples/16_6exists_family.md
Normal file
4
tests/results/test_examples/16_6exists_family.md
Normal file
|
|
@ -0,0 +1,4 @@
|
||||||
|
---
|
||||||
|
gitea: none
|
||||||
|
include_toc: true
|
||||||
|
---
|
||||||
71
tests/results/test_examples/20_9family_absolute.md
Normal file
71
tests/results/test_examples/20_9family_absolute.md
Normal file
|
|
@ -0,0 +1,71 @@
|
||||||
|
---
|
||||||
|
gitea: none
|
||||||
|
include_toc: true
|
||||||
|
---
|
||||||
|
# Variables
|
||||||
|
|
||||||
|
| Variable | Description |
|
||||||
|
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
|
| **var1**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | First variable. |
|
||||||
|
|
||||||
|
## a family
|
||||||
|
|
||||||
|
`basic`
|
||||||
|
|
||||||
|
| Variable | Description |
|
||||||
|
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
|
| **family.var2**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A second variable.<br/>**Example**: string6 |
|
||||||
|
|
||||||
|
### a sub family
|
||||||
|
|
||||||
|
`standard`
|
||||||
|
|
||||||
|
| Variable | Description |
|
||||||
|
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
|
| **family.subfamily.variable**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | Third variable.<br/>**Default**: <br/>- the value of the variable "var1".<br/>- the value of the variable "family.var2". |
|
||||||
|
|
||||||
|
## a family
|
||||||
|
|
||||||
|
`standard`
|
||||||
|
|
||||||
|
| Variable | Description |
|
||||||
|
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
|
| **family2.var2**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable2.<br/>**Default**: the value of the variable "family.var2". |
|
||||||
|
| **family2.var3**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Var3.<br/>**Default**: string4<br/>**Example**: string5 |
|
||||||
|
|
||||||
|
### a sub family
|
||||||
|
|
||||||
|
`standard`
|
||||||
|
|
||||||
|
| Variable | Description |
|
||||||
|
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
|
| **family2.subfamily.variable**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | Fourth variable.<br/>**Default**: <br/>- the value of the variable "var1".<br/>- the value of the variable "family.var2".<br/>- the value of the variable "family2.var3". |
|
||||||
|
|
||||||
|
# Example with mandatory variables not filled in
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
---
|
||||||
|
var1: example
|
||||||
|
family:
|
||||||
|
var2: string6
|
||||||
|
```
|
||||||
|
# Example with all variables modifiable
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
---
|
||||||
|
var1: example
|
||||||
|
family:
|
||||||
|
var2: string6
|
||||||
|
subfamily:
|
||||||
|
variable:
|
||||||
|
-
|
||||||
|
-
|
||||||
|
family2:
|
||||||
|
var2: example
|
||||||
|
var3: string5
|
||||||
|
subfamily:
|
||||||
|
variable:
|
||||||
|
-
|
||||||
|
-
|
||||||
|
- string4
|
||||||
|
```
|
||||||
|
|
@ -0,0 +1,18 @@
|
||||||
|
== Variables for "Rougail"
|
||||||
|
|
||||||
|
[cols="1a,1a"]
|
||||||
|
|====
|
||||||
|
| Variable | Description
|
||||||
|
|
|
||||||
|
|
||||||
|
**rougail.var1** +
|
||||||
|
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` |
|
||||||
|
A first variable.
|
||||||
|
|
|
||||||
|
|
||||||
|
**rougail.var2** +
|
||||||
|
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` |
|
||||||
|
A second variable. +
|
||||||
|
**Default**: the value of the information "test_information" of the variable "rougail.var1".
|
||||||
|
|====
|
||||||
|
|
||||||
|
|
@ -0,0 +1 @@
|
||||||
|
{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"var1": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.var1"], "names": ["var1"], "descriptions": ["A first variable."]}, "var2": {"type": "variable", "default": "the value of the information \"test_information\" of the variable \"rougail.var1\".", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.var2"], "names": ["var2"], "descriptions": ["A second variable."]}}}}
|
||||||
|
|
@ -0,0 +1,11 @@
|
||||||
|
---
|
||||||
|
gitea: none
|
||||||
|
include_toc: true
|
||||||
|
---
|
||||||
|
# Variables for "Rougail"
|
||||||
|
|
||||||
|
| Variable | Description |
|
||||||
|
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
|
| **rougail.var1**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A first variable. |
|
||||||
|
| **rougail.var2**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second variable.<br/>**Default**: the value of the information "test_information" of the variable "rougail.var1". |
|
||||||
|
|
||||||
|
|
@ -0,0 +1,18 @@
|
||||||
|
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
|
||||||
|
┃ [1mVariables for "Rougail"[0m ┃
|
||||||
|
┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
[1m [0m[1mVariable [0m[1m [0m [1m [0m[1mDescription [0m[1m [0m
|
||||||
|
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
||||||
|
[1mrougail.var1[0m
|
||||||
|
[1;36;40mstring[0m [1;36;40mbasic[0m [1;36;40mmandatory[0m A first variable.
|
||||||
|
[1mrougail.var2[0m
|
||||||
|
[1;36;40mstring[0m [1;36;40mstandard[0m [1;36;40mmandatory[0m A second variable.
|
||||||
|
[1mDefault[0m: the value of the information
|
||||||
|
"test_information" of the variable
|
||||||
|
"rougail.var1".
|
||||||
|
|
||||||
26
tests/results/test_namespace/00_9extra_ouside.adoc
Normal file
26
tests/results/test_namespace/00_9extra_ouside.adoc
Normal file
|
|
@ -0,0 +1,26 @@
|
||||||
|
== Variables for "Rougail"
|
||||||
|
|
||||||
|
[cols="1a,1a"]
|
||||||
|
|====
|
||||||
|
| Variable | Description
|
||||||
|
|
|
||||||
|
|
||||||
|
**rougail.variable** +
|
||||||
|
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` |
|
||||||
|
A variable. +
|
||||||
|
**Default**: the value of the variable "extra.variable".
|
||||||
|
|====
|
||||||
|
|
||||||
|
== Variables for "extra"
|
||||||
|
|
||||||
|
[cols="1a,1a"]
|
||||||
|
|====
|
||||||
|
| Variable | Description
|
||||||
|
|
|
||||||
|
|
||||||
|
**extra.variable** +
|
||||||
|
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` |
|
||||||
|
A variable. +
|
||||||
|
**Default**: value in extra
|
||||||
|
|====
|
||||||
|
|
||||||
1
tests/results/test_namespace/00_9extra_ouside.json
Normal file
1
tests/results/test_namespace/00_9extra_ouside.json
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"variable": {"type": "variable", "default": "the value of the variable \"extra.variable\".", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.variable"], "names": ["variable"], "descriptions": ["A variable."]}}}, "extra": {"type": "namespace", "informations": {"paths": ["extra"], "names": ["extra"], "description": "extra", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"variable": {"type": "variable", "default": "value in extra", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["extra.variable"], "names": ["variable"], "descriptions": ["A variable."]}}}}
|
||||||
16
tests/results/test_namespace/00_9extra_ouside.md
Normal file
16
tests/results/test_namespace/00_9extra_ouside.md
Normal file
|
|
@ -0,0 +1,16 @@
|
||||||
|
---
|
||||||
|
gitea: none
|
||||||
|
include_toc: true
|
||||||
|
---
|
||||||
|
# Variables for "Rougail"
|
||||||
|
|
||||||
|
| Variable | Description |
|
||||||
|
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
|
| **rougail.variable**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.<br/>**Default**: the value of the variable "extra.variable". |
|
||||||
|
|
||||||
|
# Variables for "extra"
|
||||||
|
|
||||||
|
| Variable | Description |
|
||||||
|
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
|
| **extra.variable**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.<br/>**Default**: value in extra |
|
||||||
|
|
||||||
28
tests/results/test_namespace/00_9extra_ouside.sh
Normal file
28
tests/results/test_namespace/00_9extra_ouside.sh
Normal file
|
|
@ -0,0 +1,28 @@
|
||||||
|
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
|
||||||
|
┃ [1mVariables for "Rougail"[0m ┃
|
||||||
|
┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
[1m [0m[1mVariable [0m[1m [0m [1m [0m[1mDescription [0m[1m [0m
|
||||||
|
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
||||||
|
[1mrougail.variable[0m
|
||||||
|
[1;36;40mstring[0m [1;36;40mstandard[0m [1;36;40mmandatory[0m A variable.
|
||||||
|
[1mDefault[0m: the value of the variable
|
||||||
|
"extra.variable".
|
||||||
|
|
||||||
|
|
||||||
|
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
|
||||||
|
┃ [1mVariables for "extra"[0m ┃
|
||||||
|
┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
[1m [0m[1mVariable [0m[1m [0m [1m [0m[1mDescription [0m[1m [0m
|
||||||
|
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
||||||
|
[1mextra.variable[0m
|
||||||
|
[1;36;40mstring[0m [1;36;40mstandard[0m [1;36;40mmandatory[0m A variable.
|
||||||
|
[1mDefault[0m: value in extra
|
||||||
|
|
||||||
|
|
@ -16,7 +16,7 @@ The second variable.
|
||||||
|
|
|
|
||||||
|
|
||||||
**rougail.var3** +
|
**rougail.var3** +
|
||||||
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` |
|
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` |
|
||||||
The third variable.
|
The third variable.
|
||||||
|
|
|
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1 +1 @@
|
||||||
{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"var1": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var1"], "names": ["var1"], "descriptions": ["The first variable."], "multiple": true}, "var2": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var2"], "names": ["var2"], "descriptions": ["The second variable."], "multiple": true}, "var3": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.var3"], "names": ["var3"], "descriptions": ["The third variable."]}, "var4": {"type": "variable", "default": ["value"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var4"], "names": ["var4"], "descriptions": ["The forth variable."], "multiple": true}, "var5": {"type": "variable", "default": ["value"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var5"], "names": ["var5"], "descriptions": ["The fifth variable."], "multiple": true}, "var6": {"type": "variable", "default": ["value"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var6"], "names": ["var6"], "descriptions": ["The sixth variable."], "multiple": true}, "var7": {"type": "variable", "default": ["value"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var7"], "names": ["var7"], "descriptions": ["The seventh variable."], "multiple": true}, "var8": {"type": "variable", "default": ["value"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var8"], "names": ["var8"], "descriptions": ["The eighth variable."], "multiple": true}}}}
|
{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"var1": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var1"], "names": ["var1"], "descriptions": ["The first variable."], "multiple": true}, "var2": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var2"], "names": ["var2"], "descriptions": ["The second variable."], "multiple": true}, "var3": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var3"], "names": ["var3"], "descriptions": ["The third variable."], "multiple": true}, "var4": {"type": "variable", "default": ["value"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var4"], "names": ["var4"], "descriptions": ["The forth variable."], "multiple": true}, "var5": {"type": "variable", "default": ["value"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var5"], "names": ["var5"], "descriptions": ["The fifth variable."], "multiple": true}, "var6": {"type": "variable", "default": ["value"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var6"], "names": ["var6"], "descriptions": ["The sixth variable."], "multiple": true}, "var7": {"type": "variable", "default": ["value"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var7"], "names": ["var7"], "descriptions": ["The seventh variable."], "multiple": true}, "var8": {"type": "variable", "default": ["value"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var8"], "names": ["var8"], "descriptions": ["The eighth variable."], "multiple": true}}}}
|
||||||
|
|
@ -8,7 +8,7 @@ include_toc: true
|
||||||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
| **rougail.var1**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | The first variable. |
|
| **rougail.var1**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | The first variable. |
|
||||||
| **rougail.var2**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | The second variable. |
|
| **rougail.var2**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | The second variable. |
|
||||||
| **rougail.var3**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The third variable. |
|
| **rougail.var3**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | The third variable. |
|
||||||
| **rougail.var4**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The forth variable.<br/>**Default**: value |
|
| **rougail.var4**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The forth variable.<br/>**Default**: value |
|
||||||
| **rougail.var5**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The fifth variable.<br/>**Default**: value |
|
| **rougail.var5**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The fifth variable.<br/>**Default**: value |
|
||||||
| **rougail.var6**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The sixth variable.<br/>**Default**: value |
|
| **rougail.var6**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The sixth variable.<br/>**Default**: value |
|
||||||
|
|
|
||||||
|
|
@ -25,7 +25,8 @@
|
||||||
[1;36;40mstring[0m [1;36;40mbasic[0m [1;36;40mmandatory[0m [1;36;40munique[0m The second variable.
|
[1;36;40mstring[0m [1;36;40mbasic[0m [1;36;40mmandatory[0m [1;36;40munique[0m The second variable.
|
||||||
[1;36;40mmultiple[0m
|
[1;36;40mmultiple[0m
|
||||||
[1mrougail.var3[0m
|
[1mrougail.var3[0m
|
||||||
[1;36;40mstring[0m [1;36;40mbasic[0m [1;36;40mmandatory[0m The third variable.
|
[1;36;40mstring[0m [1;36;40mbasic[0m [1;36;40mmandatory[0m [1;36;40munique[0m The third variable.
|
||||||
|
[1;36;40mmultiple[0m
|
||||||
[1mrougail.var4[0m
|
[1mrougail.var4[0m
|
||||||
[1;36;40mstring[0m [1;36;40mstandard[0m [1;36;40mmandatory[0m [1;36;40munique[0m The forth variable.
|
[1;36;40mstring[0m [1;36;40mstandard[0m [1;36;40mmandatory[0m [1;36;40munique[0m The forth variable.
|
||||||
[1;36;40mmultiple[0m
|
[1;36;40mmultiple[0m
|
||||||
|
|
|
||||||
0
tests/results/test_namespace/16_6exists_family.adoc
Normal file
0
tests/results/test_namespace/16_6exists_family.adoc
Normal file
1
tests/results/test_namespace/16_6exists_family.json
Normal file
1
tests/results/test_namespace/16_6exists_family.json
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
{}
|
||||||
4
tests/results/test_namespace/16_6exists_family.md
Normal file
4
tests/results/test_namespace/16_6exists_family.md
Normal file
|
|
@ -0,0 +1,4 @@
|
||||||
|
---
|
||||||
|
gitea: none
|
||||||
|
include_toc: true
|
||||||
|
---
|
||||||
0
tests/results/test_namespace/16_6exists_family.sh
Normal file
0
tests/results/test_namespace/16_6exists_family.sh
Normal file
|
|
@ -0,0 +1,72 @@
|
||||||
|
== Variables for "Rougail"
|
||||||
|
|
||||||
|
[cols="1a,1a"]
|
||||||
|
|====
|
||||||
|
| Variable | Description
|
||||||
|
|
|
||||||
|
|
||||||
|
**rougail.var** +
|
||||||
|
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `unique` `multiple` |
|
||||||
|
A identifier variable. +
|
||||||
|
**Default**:
|
||||||
|
|
||||||
|
* val1
|
||||||
|
* val2
|
||||||
|
|====
|
||||||
|
|
||||||
|
=== A dynamic family
|
||||||
|
|
||||||
|
`standard`
|
||||||
|
|
||||||
|
This family builds families dynamically.
|
||||||
|
|
||||||
|
**Identifiers**: the value of the variable "rougail.var".
|
||||||
|
|
||||||
|
[cols="1a,1a"]
|
||||||
|
|====
|
||||||
|
| Variable | Description
|
||||||
|
|
|
||||||
|
|
||||||
|
**rougail.dyn__val1__.var** +
|
||||||
|
**rougail.dyn__val2__.var** +
|
||||||
|
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `unique` `multiple` |
|
||||||
|
A dynamic variable.
|
||||||
|
|====
|
||||||
|
|
||||||
|
==== a Second dynamic variable
|
||||||
|
|
||||||
|
`standard`
|
||||||
|
|
||||||
|
This family builds families dynamically.
|
||||||
|
|
||||||
|
**Identifiers**:
|
||||||
|
|
||||||
|
* the value of the variable "rougail.dyn__val1__.var"
|
||||||
|
* the value of the variable "rougail.dyn__val2__.var"
|
||||||
|
|
||||||
|
[cols="1a,1a"]
|
||||||
|
|====
|
||||||
|
| Variable | Description
|
||||||
|
|
|
||||||
|
|
||||||
|
**rougail.dyn__val1__.dyn___example__.var** +
|
||||||
|
**rougail.dyn__val2__.dyn___example__.var** +
|
||||||
|
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` |
|
||||||
|
A variable dynamic. +
|
||||||
|
**Default**: the value of the identifier.
|
||||||
|
|
|
||||||
|
|
||||||
|
**rougail.dyn__val1__.dyn___example__.var_identifier** +
|
||||||
|
**rougail.dyn__val2__.dyn___example__.var_identifier** +
|
||||||
|
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` |
|
||||||
|
Identifier from first family. +
|
||||||
|
**Default**: the value of the identifier.
|
||||||
|
|
|
||||||
|
|
||||||
|
**rougail.dyn__val1__.dyn___example__.var_identifiers** +
|
||||||
|
**rougail.dyn__val2__.dyn___example__.var_identifiers** +
|
||||||
|
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` |
|
||||||
|
Merge identifiers. +
|
||||||
|
**Default**: join identifier 1 et identifier 2.
|
||||||
|
|====
|
||||||
|
|
||||||
|
|
@ -0,0 +1 @@
|
||||||
|
{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"var": {"type": "variable", "default": ["val1", "val2"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var"], "names": ["var"], "descriptions": ["A identifier variable."], "multiple": true}, "dyn{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["rougail.dynval1", "rougail.dynval2"], "names": ["dynval1", "dynval2"], "description": "A dynamic family", "properties": [{"type": "mode", "name": "standard"}], "identifiers": "the value of the variable \"rougail.var\".", "help": ["This family builds families dynamically."]}, "children": {"var": {"paths": ["rougail.dynval1.var", "rougail.dynval2.var"], "names": ["var", "var"], "type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "descriptions": ["A dynamic variable."], "multiple": true}, "dyn_{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["rougail.dynval1.dyn_example", "rougail.dynval2.dyn_example"], "names": ["dyn_example", "dyn_example"], "description": "a Second dynamic variable", "properties": [{"type": "mode", "name": "standard"}], "identifiers": ["the value of the variable \"rougail.dynval1.var\"", "the value of the variable \"rougail.dynval2.var\""], "help": ["This family builds families dynamically."]}, "children": {"var": {"paths": ["rougail.dynval1.dyn_example.var", "rougail.dynval2.dyn_example.var"], "names": ["var", "var"], "type": "variable", "default": "the value of the identifier.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "descriptions": ["A variable dynamic."]}, "var_identifier": {"paths": ["rougail.dynval1.dyn_example.var_identifier", "rougail.dynval2.dyn_example.var_identifier"], "names": ["var_identifier", "var_identifier"], "type": "variable", "default": "the value of the identifier.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "descriptions": ["Identifier from first family."]}, "var_identifiers": {"paths": ["rougail.dynval1.dyn_example.var_identifiers", "rougail.dynval2.dyn_example.var_identifiers"], "names": ["var_identifiers", "var_identifiers"], "type": "variable", "default": "join identifier 1 et identifier 2.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "descriptions": ["Merge identifiers."]}}}}}}}}
|
||||||
|
|
@ -0,0 +1,36 @@
|
||||||
|
---
|
||||||
|
gitea: none
|
||||||
|
include_toc: true
|
||||||
|
---
|
||||||
|
# Variables for "Rougail"
|
||||||
|
|
||||||
|
| Variable | Description |
|
||||||
|
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
|
| **rougail.var**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A identifier variable.<br/>**Default**: <br/>- val1<br/>- val2 |
|
||||||
|
|
||||||
|
## A dynamic family
|
||||||
|
|
||||||
|
`standard`
|
||||||
|
|
||||||
|
This family builds families dynamically.
|
||||||
|
|
||||||
|
**Identifiers**: the value of the variable "rougail.var".
|
||||||
|
|
||||||
|
| Variable | Description |
|
||||||
|
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
|
| **rougail.dyn*val1*.var**<br/>**rougail.dyn*val2*.var**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A dynamic variable. |
|
||||||
|
|
||||||
|
### a Second dynamic variable
|
||||||
|
|
||||||
|
`standard`
|
||||||
|
|
||||||
|
This family builds families dynamically.
|
||||||
|
|
||||||
|
**Identifiers**: <br/>- the value of the variable "rougail.dyn*val1*.var"<br/>- the value of the variable "rougail.dyn*val2*.var"
|
||||||
|
|
||||||
|
| Variable | Description |
|
||||||
|
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
|
| **rougail.dyn*val1*.dyn_*example*.var**<br/>**rougail.dyn*val2*.dyn_*example*.var**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable dynamic.<br/>**Default**: the value of the identifier. |
|
||||||
|
| **rougail.dyn*val1*.dyn_*example*.var_identifier**<br/>**rougail.dyn*val2*.dyn_*example*.var_identifier**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Identifier from first family.<br/>**Default**: the value of the identifier. |
|
||||||
|
| **rougail.dyn*val1*.dyn_*example*.var_identifiers**<br/>**rougail.dyn*val2*.dyn_*example*.var_identifiers**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Merge identifiers.<br/>**Default**: join identifier 1 et identifier 2. |
|
||||||
|
|
||||||
|
|
@ -0,0 +1,76 @@
|
||||||
|
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
|
||||||
|
┃ [1mVariables for "Rougail"[0m ┃
|
||||||
|
┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
[1m [0m[1mVariable [0m[1m [0m [1m [0m[1mDescription [0m[1m [0m
|
||||||
|
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
||||||
|
[1mrougail.var[0m
|
||||||
|
[1;36;40mstring[0m [1;36;40mstandard[0m [1;36;40munique[0m [1;36;40mmultiple[0m A identifier variable.
|
||||||
|
[1mDefault[0m:
|
||||||
|
|
||||||
|
|
||||||
|
[1;33m • [0mval1
|
||||||
|
[1;33m • [0mval2
|
||||||
|
[1;33m [0m|
|
||||||
|
|
||||||
|
|
||||||
|
[1;4mA dynamic family[0m
|
||||||
|
|
||||||
|
[1;36;40mstandard[0m
|
||||||
|
|
||||||
|
This family builds families dynamically.
|
||||||
|
|
||||||
|
[1mIdentifiers[0m: the value of the variable "rougail.var".
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
[1m [0m[1mVariable [0m[1m [0m [1m [0m[1mDescription [0m[1m [0m
|
||||||
|
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
||||||
|
[1mrougail.dyn[0m[1;3mval1[0m[1m.var[0m
|
||||||
|
[1mrougail.dyn[0m[1;3mval2[0m[1m.var[0m
|
||||||
|
[1;36;40mstring[0m [1;36;40mstandard[0m [1;36;40munique[0m [1;36;40mmultiple[0m A dynamic variable.
|
||||||
|
|
||||||
|
|
||||||
|
[1ma Second dynamic variable[0m
|
||||||
|
|
||||||
|
[1;36;40mstandard[0m
|
||||||
|
|
||||||
|
This family builds families dynamically.
|
||||||
|
|
||||||
|
[1mIdentifiers[0m:
|
||||||
|
|
||||||
|
[1;33m • [0mthe value of the variable "rougail.dyn[3mval1[0m.var"
|
||||||
|
[1;33m • [0mthe value of the variable "rougail.dyn[3mval2[0m.var"
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
[1m [0m[1mVariable [0m[1m [0m [1m [0m[1mDescription [0m[1m [0m
|
||||||
|
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
||||||
|
[1mrougail.dyn[0m[1;3mval1[0m[1m.dyn_[0m[1;3mexample[0m[1m.var[0m
|
||||||
|
[1mrougail.dyn[0m[1;3mval2[0m[1m.dyn_[0m[1;3mexample[0m[1m.var[0m
|
||||||
|
[1;36;40mstring[0m [1;36;40mstandard[0m [1;36;40mmandatory[0m A variable dynamic.
|
||||||
|
[1mDefault[0m: the value of the
|
||||||
|
identifier.
|
||||||
|
[1mrougail.dyn[0m[1;3mval1[0m[1m.dyn_[0m[1;3mexample[0m[1m.var_ide…[0m
|
||||||
|
[1mrougail.dyn[0m[1;3mval2[0m[1m.dyn_[0m[1;3mexample[0m[1m.var_ide…[0m
|
||||||
|
[1;36;40mstring[0m [1;36;40mstandard[0m [1;36;40mmandatory[0m Identifier from first family.
|
||||||
|
[1mDefault[0m: the value of the
|
||||||
|
identifier.
|
||||||
|
[1mrougail.dyn[0m[1;3mval1[0m[1m.dyn_[0m[1;3mexample[0m[1m.var_ide…[0m
|
||||||
|
[1mrougail.dyn[0m[1;3mval2[0m[1m.dyn_[0m[1;3mexample[0m[1m.var_ide…[0m
|
||||||
|
[1;36;40mstring[0m [1;36;40mstandard[0m [1;36;40mmandatory[0m Merge identifiers.
|
||||||
|
[1mDefault[0m: join identifier 1 et
|
||||||
|
identifier 2.
|
||||||
|
|
||||||
|
|
@ -0,0 +1,26 @@
|
||||||
|
---
|
||||||
|
gitea: none
|
||||||
|
include_toc: true
|
||||||
|
---
|
||||||
|
# Variables for "Rougail"
|
||||||
|
|
||||||
|
| Variable | Description |
|
||||||
|
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
|
| **rougail.var1**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A first variable. |
|
||||||
|
| **rougail.var2**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second variable.<br/>**Default**: the value of the information "test_information" of the variable "rougail.var1". |
|
||||||
|
|
||||||
|
# Example with mandatory variables not filled in
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
---
|
||||||
|
rougail:
|
||||||
|
var1: example
|
||||||
|
```
|
||||||
|
# Example with all variables modifiable
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
---
|
||||||
|
rougail:
|
||||||
|
var1: example
|
||||||
|
var2: example
|
||||||
|
```
|
||||||
25
tests/results/test_namespace_examples/00_9extra_ouside.md
Normal file
25
tests/results/test_namespace_examples/00_9extra_ouside.md
Normal file
|
|
@ -0,0 +1,25 @@
|
||||||
|
---
|
||||||
|
gitea: none
|
||||||
|
include_toc: true
|
||||||
|
---
|
||||||
|
# Variables for "Rougail"
|
||||||
|
|
||||||
|
| Variable | Description |
|
||||||
|
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
|
| **rougail.variable**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.<br/>**Default**: the value of the variable "extra.variable". |
|
||||||
|
|
||||||
|
# Variables for "extra"
|
||||||
|
|
||||||
|
| Variable | Description |
|
||||||
|
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
|
| **extra.variable**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.<br/>**Default**: value in extra |
|
||||||
|
|
||||||
|
# Example with all variables modifiable
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
---
|
||||||
|
rougail:
|
||||||
|
variable: value in extra
|
||||||
|
extra:
|
||||||
|
variable: value in extra
|
||||||
|
```
|
||||||
|
|
@ -8,7 +8,7 @@ include_toc: true
|
||||||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
| **rougail.var1**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | The first variable. |
|
| **rougail.var1**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | The first variable. |
|
||||||
| **rougail.var2**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | The second variable. |
|
| **rougail.var2**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | The second variable. |
|
||||||
| **rougail.var3**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The third variable. |
|
| **rougail.var3**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | The third variable. |
|
||||||
| **rougail.var4**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The forth variable.<br/>**Default**: value |
|
| **rougail.var4**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The forth variable.<br/>**Default**: value |
|
||||||
| **rougail.var5**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The fifth variable.<br/>**Default**: value |
|
| **rougail.var5**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The fifth variable.<br/>**Default**: value |
|
||||||
| **rougail.var6**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The sixth variable.<br/>**Default**: value |
|
| **rougail.var6**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The sixth variable.<br/>**Default**: value |
|
||||||
|
|
@ -24,7 +24,8 @@ rougail:
|
||||||
- example
|
- example
|
||||||
var2:
|
var2:
|
||||||
- example
|
- example
|
||||||
var3: example
|
var3:
|
||||||
|
- example
|
||||||
```
|
```
|
||||||
# Example with all variables modifiable
|
# Example with all variables modifiable
|
||||||
|
|
||||||
|
|
@ -35,7 +36,8 @@ rougail:
|
||||||
- example
|
- example
|
||||||
var2:
|
var2:
|
||||||
- example
|
- example
|
||||||
var3: example
|
var3:
|
||||||
|
- example
|
||||||
var4:
|
var4:
|
||||||
- value
|
- value
|
||||||
var5:
|
var5:
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,4 @@
|
||||||
|
---
|
||||||
|
gitea: none
|
||||||
|
include_toc: true
|
||||||
|
---
|
||||||
|
|
@ -0,0 +1,59 @@
|
||||||
|
---
|
||||||
|
gitea: none
|
||||||
|
include_toc: true
|
||||||
|
---
|
||||||
|
# Variables for "Rougail"
|
||||||
|
|
||||||
|
| Variable | Description |
|
||||||
|
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
|
| **rougail.var**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A identifier variable.<br/>**Default**: <br/>- val1<br/>- val2 |
|
||||||
|
|
||||||
|
## A dynamic family
|
||||||
|
|
||||||
|
`standard`
|
||||||
|
|
||||||
|
This family builds families dynamically.
|
||||||
|
|
||||||
|
**Identifiers**: the value of the variable "rougail.var".
|
||||||
|
|
||||||
|
| Variable | Description |
|
||||||
|
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
|
| **rougail.dyn*val1*.var**<br/>**rougail.dyn*val2*.var**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A dynamic variable. |
|
||||||
|
|
||||||
|
### a Second dynamic variable
|
||||||
|
|
||||||
|
`standard`
|
||||||
|
|
||||||
|
This family builds families dynamically.
|
||||||
|
|
||||||
|
**Identifiers**: <br/>- the value of the variable "rougail.dyn*val1*.var"<br/>- the value of the variable "rougail.dyn*val2*.var"
|
||||||
|
|
||||||
|
| Variable | Description |
|
||||||
|
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
|
| **rougail.dyn*val1*.dyn_*example*.var**<br/>**rougail.dyn*val2*.dyn_*example*.var**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable dynamic.<br/>**Default**: the value of the identifier. |
|
||||||
|
| **rougail.dyn*val1*.dyn_*example*.var_identifier**<br/>**rougail.dyn*val2*.dyn_*example*.var_identifier**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Identifier from first family.<br/>**Default**: the value of the identifier. |
|
||||||
|
| **rougail.dyn*val1*.dyn_*example*.var_identifiers**<br/>**rougail.dyn*val2*.dyn_*example*.var_identifiers**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Merge identifiers.<br/>**Default**: join identifier 1 et identifier 2. |
|
||||||
|
|
||||||
|
# Example with all variables modifiable
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
---
|
||||||
|
rougail:
|
||||||
|
var:
|
||||||
|
- val1
|
||||||
|
- val2
|
||||||
|
dynval1:
|
||||||
|
var:
|
||||||
|
- example
|
||||||
|
dyn_example:
|
||||||
|
var: example
|
||||||
|
var_identifier: val1
|
||||||
|
var_identifiers: val1-example
|
||||||
|
dynval2:
|
||||||
|
var:
|
||||||
|
- example
|
||||||
|
dyn_example:
|
||||||
|
var: example
|
||||||
|
var_identifier: val2
|
||||||
|
var_identifiers: val2-example
|
||||||
|
```
|
||||||
27
tests/test_cmdline.py
Normal file
27
tests/test_cmdline.py
Normal file
|
|
@ -0,0 +1,27 @@
|
||||||
|
from pathlib import Path
|
||||||
|
from rougail import Rougail
|
||||||
|
from rougail.config import get_rougail_config
|
||||||
|
from rougail.output_doc import RougailOutputDoc
|
||||||
|
|
||||||
|
|
||||||
|
def test_force_optional():
|
||||||
|
print('FIXME')
|
||||||
|
# test_dir = Path(__file__).resolve().parent
|
||||||
|
# rougailconfig = get_rougail_config(backward_compatibility=False)
|
||||||
|
# rougailconfig['step.output'] = 'doc'
|
||||||
|
## rougailconfig['tiramisu_cache'] = 'p.py'
|
||||||
|
# dirs = [str(test_dir / 'cmdline')]
|
||||||
|
# rougailconfig['plugins'] = ["structural_commandline"]
|
||||||
|
# rougailconfig['main_dictionaries'] = dirs
|
||||||
|
# rougailconfig['doc.output_format'] = 'asciidoc'
|
||||||
|
# rougail = Rougail(rougailconfig)
|
||||||
|
# config = rougail.run()
|
||||||
|
# inventory = RougailOutputDoc(config, rougailconfig=rougailconfig)
|
||||||
|
# doc = inventory.run()
|
||||||
|
# result_file = test_dir / 'cmdline.adoc'
|
||||||
|
# if not result_file.is_file():
|
||||||
|
# with open(str(result_file), 'w') as docfh:
|
||||||
|
# docfh.write(doc)
|
||||||
|
# with open(str(result_file)) as docfh:
|
||||||
|
# result = docfh.read()
|
||||||
|
# assert doc == result
|
||||||
|
|
@ -1,4 +1,5 @@
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
|
from rougail import Rougail
|
||||||
from rougail.config import get_rougail_config
|
from rougail.config import get_rougail_config
|
||||||
from rougail.output_doc import RougailOutputDoc
|
from rougail.output_doc import RougailOutputDoc
|
||||||
|
|
||||||
|
|
@ -12,8 +13,10 @@ def test_force_optional():
|
||||||
dirs = [str(test_dir / 'force_optional')]
|
dirs = [str(test_dir / 'force_optional')]
|
||||||
rougailconfig['main_dictionaries'] = dirs
|
rougailconfig['main_dictionaries'] = dirs
|
||||||
rougailconfig['doc.output_format'] = 'asciidoc'
|
rougailconfig['doc.output_format'] = 'asciidoc'
|
||||||
inventory = RougailOutputDoc(rougailconfig=rougailconfig)
|
rougail = Rougail(rougailconfig)
|
||||||
doc = inventory.gen_doc()
|
config = rougail.run()
|
||||||
|
inventory = RougailOutputDoc(config, rougailconfig=rougailconfig)
|
||||||
|
doc = inventory.run()
|
||||||
result_file = test_dir / 'force_optional.adoc'
|
result_file = test_dir / 'force_optional.adoc'
|
||||||
if not result_file.is_file():
|
if not result_file.is_file():
|
||||||
with open(str(result_file), 'w') as docfh:
|
with open(str(result_file), 'w') as docfh:
|
||||||
|
|
|
||||||
|
|
@ -14,7 +14,7 @@ excludes = [
|
||||||
]
|
]
|
||||||
|
|
||||||
test_ok = get_structures_list(excludes)
|
test_ok = get_structures_list(excludes)
|
||||||
#test_ok = [Path('../rougail-tests/structures/00_0version_underscore')]
|
# test_ok = [Path('../rougail-tests/structures/60_6family_dynamic_sub_dynamic_empty2')]
|
||||||
|
|
||||||
|
|
||||||
os.environ['COLUMNS'] = '80'
|
os.environ['COLUMNS'] = '80'
|
||||||
|
|
|
||||||
|
|
@ -1,4 +1,5 @@
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
|
from rougail import Rougail
|
||||||
from rougail.config import get_rougail_config
|
from rougail.config import get_rougail_config
|
||||||
from rougail.output_doc import RougailOutputDoc
|
from rougail.output_doc import RougailOutputDoc
|
||||||
|
|
||||||
|
|
@ -13,8 +14,10 @@ def _test(modes):
|
||||||
rougailconfig['main_dictionaries'] = dirs
|
rougailconfig['main_dictionaries'] = dirs
|
||||||
rougailconfig['doc.output_format'] = 'asciidoc'
|
rougailconfig['doc.output_format'] = 'asciidoc'
|
||||||
rougailconfig['doc.disabled_modes'] = modes
|
rougailconfig['doc.disabled_modes'] = modes
|
||||||
inventory = RougailOutputDoc(rougailconfig=rougailconfig)
|
rougail = Rougail(rougailconfig)
|
||||||
doc = inventory.gen_doc()
|
config = rougail.run()
|
||||||
|
inventory = RougailOutputDoc(config, rougailconfig=rougailconfig)
|
||||||
|
doc = inventory.run()
|
||||||
result_file = test_dir / f'mode_{"_".join(modes)}.adoc'
|
result_file = test_dir / f'mode_{"_".join(modes)}.adoc'
|
||||||
if not result_file.is_file():
|
if not result_file.is_file():
|
||||||
with open(str(result_file), 'w') as docfh:
|
with open(str(result_file), 'w') as docfh:
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue