diff --git a/src/rougail/output_doc/doc.py b/src/rougail/output_doc/doc.py index 50c06578a..b4638a0cb 100644 --- a/src/rougail/output_doc/doc.py +++ b/src/rougail/output_doc/doc.py @@ -701,10 +701,12 @@ class RougailOutputDoc(Examples): def _calculation_variable_to_string(self, child, calculation, prop): if prop in PROPERTY_ATTRIBUTE: variable_path, value, condition = calculation["value"] - variable = self.conf.unrestraint.option(variable_path) + variable = self.conf.forcepermissive.option(variable_path) try: variable.value.get() except AttributeError as err: + if prop in HIDDEN_PROPERTIES: + return False variable = None if variable and self._is_inaccessible_user_data(variable): try: diff --git a/tests/force_optional.adoc b/tests/force_optional.adoc index 1e5ddd393..3fe15d2fe 100644 --- a/tests/force_optional.adoc +++ b/tests/force_optional.adoc @@ -22,9 +22,8 @@ My var3. + | **var4** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `mandatory` `__hidden__` | -My var4. + -**Hidden**: when the variable "a.unknown.variable" has the value "value". +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `mandatory` | +My var4. | **var5** + @@ -81,26 +80,22 @@ A variable. | **var_10** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `mandatory` `__hidden__` | -My var10. + -**Hidden**: when the variable "a.unknown.variable" has the value "val". +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `mandatory` | +My var10. | **var_11** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `mandatory` `__hidden__` | -My var11. + -**Hidden**: when the variable "a.unknown.variable" hasn't the value "val". +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `mandatory` | +My var11. | **var_12** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `mandatory` `__hidden__` | -My var12. + -**Hidden**: when the variable "a.unknown.variable" is defined and has the value "true". +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `mandatory` | +My var12. | **var_13** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `mandatory` `__hidden__` | -My var13. + -**Hidden**: when the variable "a.unknown.variable" has the value "true". +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `mandatory` | +My var13. |==== diff --git a/tests/results/test/04_5disabled_calculation_optional_default.adoc b/tests/results/test/04_5disabled_calculation_optional_default.adoc index 540daa786..781fa5603 100644 --- a/tests/results/test/04_5disabled_calculation_optional_default.adoc +++ b/tests/results/test/04_5disabled_calculation_optional_default.adoc @@ -10,9 +10,8 @@ A condition. + | **var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `__hidden__` | -A first variable. + -**Hidden**: when the variable "unknown" is defined and has the value "true". +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | +A first variable. | **var3** + diff --git a/tests/results/test/04_5disabled_calculation_optional_default.gitlab.md b/tests/results/test/04_5disabled_calculation_optional_default.gitlab.md index 96d6cb241..8bdc37af1 100644 --- a/tests/results/test/04_5disabled_calculation_optional_default.gitlab.md +++ b/tests/results/test/04_5disabled_calculation_optional_default.gitlab.md @@ -1,7 +1,7 @@ | Variable | Description | |------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------| | **condition**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.
**Default**: false | -| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` *`hidden`* | A first variable.
**Hidden**: when the variable "unknown" is defined and has the value "true". | +| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A first variable. | | **var3**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` *`hidden`* | A second variable.
**Hidden**: when the variable "condition" is defined and has the value "true". | | **var4**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` *`hidden`* | A forth variable.
**Hidden**: when the variable "condition" is defined and has the value "true". | diff --git a/tests/results/test/04_5disabled_calculation_optional_default.json b/tests/results/test/04_5disabled_calculation_optional_default.json index 88332e43d..b842bd0d0 100644 --- a/tests/results/test/04_5disabled_calculation_optional_default.json +++ b/tests/results/test/04_5disabled_calculation_optional_default.json @@ -39,11 +39,6 @@ { "type": "mode", "name": "standard" - }, - { - "type": "property", - "name": "hidden", - "annotation": "when the variable \"unknown\" is defined and has the value \"true\"." } ], "paths": [ diff --git a/tests/results/test/04_5disabled_calculation_optional_default.md b/tests/results/test/04_5disabled_calculation_optional_default.md index 55914546b..c5e237fea 100644 --- a/tests/results/test/04_5disabled_calculation_optional_default.md +++ b/tests/results/test/04_5disabled_calculation_optional_default.md @@ -1,7 +1,7 @@ | Variable                                                                                                    | Description                                                                                                 | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **condition**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.
**Default**: false | -| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` *`hidden`* | A first variable.
**Hidden**: when the variable "unknown" is defined and has the value "true". | +| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A first variable. | | **var3**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` *`hidden`* | A second variable.
**Hidden**: when the variable "condition" is defined and has the value "true". | | **var4**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` *`hidden`* | A forth variable.
**Hidden**: when the variable "condition" is defined and has the value "true". | diff --git a/tests/results/test/04_5disabled_calculation_optional_default.sh b/tests/results/test/04_5disabled_calculation_optional_default.sh index 1c2fe95eb..80c9021a7 100644 --- a/tests/results/test/04_5disabled_calculation_optional_default.sh +++ b/tests/results/test/04_5disabled_calculation_optional_default.sh @@ -5,8 +5,7 @@ โ”‚  boolean   standard   mandatory  โ”‚ Default: false โ”‚ โ”œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค โ”‚ var1 โ”‚ A first variable. โ”‚ -โ”‚  string   standard   hidden  โ”‚ Hidden: when the variable "unknown" โ”‚ -โ”‚ โ”‚ is defined and has the value "true". โ”‚ +โ”‚  string   standard  โ”‚ โ”‚ โ”œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค โ”‚ var3 โ”‚ A second variable. โ”‚ โ”‚  string   standard   hidden  โ”‚ Hidden: when the variable โ”‚ diff --git a/tests/results/test/04_5disabled_calculation_variable9.adoc b/tests/results/test/04_5disabled_calculation_variable9.adoc index e69de29bb..12f239021 100644 --- a/tests/results/test/04_5disabled_calculation_variable9.adoc +++ b/tests/results/test/04_5disabled_calculation_variable9.adoc @@ -0,0 +1,10 @@ +[cols="1a,1a"] +|==== +| Variable | Description +| + +**variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A variable. +|==== + diff --git a/tests/results/test/04_5disabled_calculation_variable9.gitlab.md b/tests/results/test/04_5disabled_calculation_variable9.gitlab.md index e69de29bb..41c59b273 100644 --- a/tests/results/test/04_5disabled_calculation_variable9.gitlab.md +++ b/tests/results/test/04_5disabled_calculation_variable9.gitlab.md @@ -0,0 +1,4 @@ +| Variable | Description | +|-------------------------------------------------------------------------------------------------------------------------|---------------| +| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | + diff --git a/tests/results/test/04_5disabled_calculation_variable9.json b/tests/results/test/04_5disabled_calculation_variable9.json index 9e26dfeeb..20c11af3f 100644 --- a/tests/results/test/04_5disabled_calculation_variable9.json +++ b/tests/results/test/04_5disabled_calculation_variable9.json @@ -1 +1,28 @@ -{} \ No newline at end of file +{ + "variable": { + "type": "variable", + "properties": [ + { + "type": "type", + "name": "string" + }, + { + "type": "mode", + "name": "basic" + }, + { + "type": "property", + "name": "mandatory" + } + ], + "paths": [ + "variable" + ], + "names": [ + "variable" + ], + "descriptions": [ + "A variable." + ] + } +} \ No newline at end of file diff --git a/tests/results/test/04_5disabled_calculation_variable9.md b/tests/results/test/04_5disabled_calculation_variable9.md index e69de29bb..547c2a690 100644 --- a/tests/results/test/04_5disabled_calculation_variable9.md +++ b/tests/results/test/04_5disabled_calculation_variable9.md @@ -0,0 +1,4 @@ +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | + diff --git a/tests/results/test/04_5disabled_calculation_variable9.sh b/tests/results/test/04_5disabled_calculation_variable9.sh index e69de29bb..638072145 100644 --- a/tests/results/test/04_5disabled_calculation_variable9.sh +++ b/tests/results/test/04_5disabled_calculation_variable9.sh @@ -0,0 +1,6 @@ +โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”ณโ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”“ +โ”ƒ Variable  โ”ƒ Description  โ”ƒ +โ”กโ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ•‡โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”ฉ +โ”‚ variable โ”‚ A variable. โ”‚ +โ”‚  string   basic   mandatory  โ”‚ โ”‚ +โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ดโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜ diff --git a/tests/results/test_examples/04_5disabled_calculation_variable9.md b/tests/results/test_examples/04_5disabled_calculation_variable9.md index e69de29bb..5f24aaeb3 100644 --- a/tests/results/test_examples/04_5disabled_calculation_variable9.md +++ b/tests/results/test_examples/04_5disabled_calculation_variable9.md @@ -0,0 +1,12 @@ +# Example with mandatory variables not filled in + +```yaml +--- +variable: example +``` +# Example with all variables modifiable + +```yaml +--- +variable: example +``` diff --git a/tests/results/test_namespace/04_5disabled_calculation_optional_default.adoc b/tests/results/test_namespace/04_5disabled_calculation_optional_default.adoc index c90244175..2b84beca7 100644 --- a/tests/results/test_namespace/04_5disabled_calculation_optional_default.adoc +++ b/tests/results/test_namespace/04_5disabled_calculation_optional_default.adoc @@ -16,9 +16,8 @@ A condition. + | **rougail.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `__hidden__` | -A first variable. + -**Hidden**: when the variable "rougail.unknown" is defined and has the value "true". +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | +A first variable. | **rougail.var3** + diff --git a/tests/results/test_namespace/04_5disabled_calculation_optional_default.gitlab.md b/tests/results/test_namespace/04_5disabled_calculation_optional_default.gitlab.md index 802b4804c..22141bde3 100644 --- a/tests/results/test_namespace/04_5disabled_calculation_optional_default.gitlab.md +++ b/tests/results/test_namespace/04_5disabled_calculation_optional_default.gitlab.md @@ -8,7 +8,7 @@ | Variable | Description | |--------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------| | **rougail.condition**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.
**Default**: false | -| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` *`hidden`* | A first variable.
**Hidden**: when the variable "rougail.unknown" is defined and has the value "true". | +| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A first variable. | | **rougail.var3**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` *`hidden`* | A second variable.
**Hidden**: when the variable "rougail.condition" is defined and has the value "true". | | **rougail.var4**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` *`hidden`* | A forth variable.
**Hidden**: when the variable "rougail.condition" is defined and has the value "true". | diff --git a/tests/results/test_namespace/04_5disabled_calculation_optional_default.json b/tests/results/test_namespace/04_5disabled_calculation_optional_default.json index 9298c2114..01a938c2e 100644 --- a/tests/results/test_namespace/04_5disabled_calculation_optional_default.json +++ b/tests/results/test_namespace/04_5disabled_calculation_optional_default.json @@ -57,11 +57,6 @@ { "type": "mode", "name": "standard" - }, - { - "type": "property", - "name": "hidden", - "annotation": "when the variable \"rougail.unknown\" is defined and has the value \"true\"." } ], "paths": [ diff --git a/tests/results/test_namespace/04_5disabled_calculation_optional_default.md b/tests/results/test_namespace/04_5disabled_calculation_optional_default.md index a0e50db03..b9abf6a87 100644 --- a/tests/results/test_namespace/04_5disabled_calculation_optional_default.md +++ b/tests/results/test_namespace/04_5disabled_calculation_optional_default.md @@ -7,7 +7,7 @@ | Variable                                                                                                    | Description                                                                                                 | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.condition**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.
**Default**: false | -| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` *`hidden`* | A first variable.
**Hidden**: when the variable "rougail.unknown" is defined and has the value "true". | +| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A first variable. | | **rougail.var3**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` *`hidden`* | A second variable.
**Hidden**: when the variable "rougail.condition" is defined and has the value "true". | | **rougail.var4**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` *`hidden`* | A forth variable.
**Hidden**: when the variable "rougail.condition" is defined and has the value "true". | diff --git a/tests/results/test_namespace/04_5disabled_calculation_optional_default.sh b/tests/results/test_namespace/04_5disabled_calculation_optional_default.sh index f0781b058..a7ffd342b 100644 --- a/tests/results/test_namespace/04_5disabled_calculation_optional_default.sh +++ b/tests/results/test_namespace/04_5disabled_calculation_optional_default.sh @@ -19,9 +19,7 @@ โ”‚  boolean   standard   mandatory  โ”‚ Default: false โ”‚ โ”œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค โ”‚ rougail.var1 โ”‚ A first variable. โ”‚ -โ”‚  string   standard   hidden  โ”‚ Hidden: when the variable โ”‚ -โ”‚ โ”‚ "rougail.unknown" is defined and has โ”‚ -โ”‚ โ”‚ the value "true". โ”‚ +โ”‚  string   standard  โ”‚ โ”‚ โ”œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค โ”‚ rougail.var3 โ”‚ A second variable. โ”‚ โ”‚  string   standard   hidden  โ”‚ Hidden: when the variable โ”‚ diff --git a/tests/results/test_namespace/04_5disabled_calculation_variable9.adoc b/tests/results/test_namespace/04_5disabled_calculation_variable9.adoc index e69de29bb..e9634d700 100644 --- a/tests/results/test_namespace/04_5disabled_calculation_variable9.adoc +++ b/tests/results/test_namespace/04_5disabled_calculation_variable9.adoc @@ -0,0 +1,16 @@ +== Variables for "Rougail" + +**rougail** + +`basic` + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**rougail.variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A variable. +|==== + diff --git a/tests/results/test_namespace/04_5disabled_calculation_variable9.gitlab.md b/tests/results/test_namespace/04_5disabled_calculation_variable9.gitlab.md index e69de29bb..f733b48dc 100644 --- a/tests/results/test_namespace/04_5disabled_calculation_variable9.gitlab.md +++ b/tests/results/test_namespace/04_5disabled_calculation_variable9.gitlab.md @@ -0,0 +1,13 @@ +
Rougail + +>>> [!note] Informations +**rougail**
`basic` + + +>>> +| Variable | Description | +|---------------------------------------------------------------------------------------------------------------------------------|---------------| +| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | + +
+ diff --git a/tests/results/test_namespace/04_5disabled_calculation_variable9.json b/tests/results/test_namespace/04_5disabled_calculation_variable9.json index 9e26dfeeb..3458aca1a 100644 --- a/tests/results/test_namespace/04_5disabled_calculation_variable9.json +++ b/tests/results/test_namespace/04_5disabled_calculation_variable9.json @@ -1 +1,48 @@ -{} \ No newline at end of file +{ + "rougail": { + "type": "namespace", + "informations": { + "paths": [ + "rougail" + ], + "names": [ + "rougail" + ], + "description": "Rougail", + "properties": [ + { + "type": "mode", + "name": "basic" + } + ] + }, + "children": { + "rougail.variable": { + "type": "variable", + "properties": [ + { + "type": "type", + "name": "string" + }, + { + "type": "mode", + "name": "basic" + }, + { + "type": "property", + "name": "mandatory" + } + ], + "paths": [ + "rougail.variable" + ], + "names": [ + "variable" + ], + "descriptions": [ + "A variable." + ] + } + } + } +} \ No newline at end of file diff --git a/tests/results/test_namespace/04_5disabled_calculation_variable9.md b/tests/results/test_namespace/04_5disabled_calculation_variable9.md index e69de29bb..177e0e87c 100644 --- a/tests/results/test_namespace/04_5disabled_calculation_variable9.md +++ b/tests/results/test_namespace/04_5disabled_calculation_variable9.md @@ -0,0 +1,10 @@ +# Variables for "Rougail" + +**rougail** + +`basic` + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | + diff --git a/tests/results/test_namespace/04_5disabled_calculation_variable9.sh b/tests/results/test_namespace/04_5disabled_calculation_variable9.sh index e69de29bb..56d76bf69 100644 --- a/tests/results/test_namespace/04_5disabled_calculation_variable9.sh +++ b/tests/results/test_namespace/04_5disabled_calculation_variable9.sh @@ -0,0 +1,21 @@ + + +Variables for "Rougail" + + + +rougail + + + + basic  + + + +โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”ณโ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”“ +โ”ƒ Variable  โ”ƒ Description  โ”ƒ +โ”กโ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ•‡โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”ฉ +โ”‚ rougail.variable โ”‚ A variable. โ”‚ +โ”‚  string   basic   mandatory  โ”‚ โ”‚ +โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ดโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜ + diff --git a/tests/results/test_namespace_examples/04_5disabled_calculation_variable9.md b/tests/results/test_namespace_examples/04_5disabled_calculation_variable9.md index e69de29bb..d6ac5352a 100644 --- a/tests/results/test_namespace_examples/04_5disabled_calculation_variable9.md +++ b/tests/results/test_namespace_examples/04_5disabled_calculation_variable9.md @@ -0,0 +1,14 @@ +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + variable: example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + variable: example +``` diff --git a/tests/test_load.py b/tests/test_load.py index a36e8a8a6..8e0573e59 100644 --- a/tests/test_load.py +++ b/tests/test_load.py @@ -20,7 +20,7 @@ excludes = [ ] test_ok = get_structures_list(excludes) -# test_ok = [HERE.parent.parent / "rougail-tests" / "structures" / "04_5disabled_calculation_variable9"] +# test_ok = [HERE.parent.parent / "rougail-tests" / "structures" / "04_5disabled_calculation_variable6"] os.environ['COLUMNS'] = '80'