fix: doc network with CIDR format

src/rougail/output_doc/utils.py

@@ -64,6 +64,11 @@ DocTypes = {
             "allow_reserved": _("reserved IP are allowed"),
         },
     },
+    "network": {
+        "params": {
+            "cidr": _("network must be in CIDR format"),
+        },
+    },
     "hostname": {
         "params": {
             "allow_ip": _("the host name can be an IP"),

tests/results/test/00_6network.adoc

@@ -12,6 +12,7 @@ An network. +
 **var2** +
 `https://rougail.readthedocs.io/en/latest/variable.html#variables-types[network]` `standard` `mandatory`            | 
 An network in CIDR format. +
+**Validator**: network must be in CIDR format +
 **Default**: 1.1.1.0/24               
 | 
 

tests/results/test/00_6network.json

@@ -49,6 +49,10 @@
         "name": "mandatory"
       }
     ],
+    "validators": {
+      "name": "Validator",
+      "values": "network must be in CIDR format"
+    },
     "paths": [
       "var2"
     ],

tests/results/test/00_6network.md

@@ -1,6 +1,6 @@
 | Variable                                                                                                           | Description                                                                                                        |
 |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
 | **var1**<br/>[`network`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | An network.<br/>**Default**: 1.1.1.0                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
-| **var2**<br/>[`network`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | An network in CIDR format.<br/>**Default**: 1.1.1.0/24                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
+| **var2**<br/>[`network`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | An network in CIDR format.<br/>**Validator**: network must be in CIDR format<br/>**Default**: 1.1.1.0/24                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
 | **var3**<br/>[`network_cidr`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               | An network in CIDR format with obsolete CIDR type.<br/>**Default**: 1.1.1.0/24                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
 

tests/results/test/00_6network.sh

@@ -5,7 +5,9 @@
 │  network   standard   mandatory       │ Default: 1.1.1.0                     │
 ├───────────────────────────────────────┼──────────────────────────────────────┤
 │ var2                                  │ An network in CIDR format.           │
-│  network   standard   mandatory       │ Default: 1.1.1.0/24                  │
+│  network   standard   mandatory       │ Validator: network must be in CIDR   │
+│                                       │ format                               │
+│                                       │ Default: 1.1.1.0/24                  │
 ├───────────────────────────────────────┼──────────────────────────────────────┤
 │ var3                                  │ An network in CIDR format with       │
 │  network_cidr   standard   mandatory  │ obsolete CIDR type.                  │

tests/results/test_namespace/00_6network.adoc

@@ -14,6 +14,7 @@ An network. +
 **rougail.var2** +
 `https://rougail.readthedocs.io/en/latest/variable.html#variables-types[network]` `standard` `mandatory`            | 
 An network in CIDR format. +
+**Validator**: network must be in CIDR format +
 **Default**: 1.1.1.0/24               
 | 
 

tests/results/test_namespace/00_6network.json

@@ -67,6 +67,10 @@
             "name": "mandatory"
           }
         ],
+        "validators": {
+          "name": "Validator",
+          "values": "network must be in CIDR format"
+        },
         "paths": [
           "rougail.var2"
         ],

tests/results/test_namespace/00_6network.md

@@ -3,6 +3,6 @@
 | Variable                                                                                                           | Description                                                                                                        |
 |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
 | **rougail.var1**<br/>[`network`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | An network.<br/>**Default**: 1.1.1.0                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
-| **rougail.var2**<br/>[`network`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | An network in CIDR format.<br/>**Default**: 1.1.1.0/24                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
+| **rougail.var2**<br/>[`network`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | An network in CIDR format.<br/>**Validator**: network must be in CIDR format<br/>**Default**: 1.1.1.0/24                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
 | **rougail.var3**<br/>[`network_cidr`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       | An network in CIDR format with obsolete CIDR type.<br/>**Default**: 1.1.1.0/24                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
 

tests/results/test_namespace/00_6network.sh

@@ -10,7 +10,9 @@
 │  network   standard   mandatory       │ Default: 1.1.1.0                     │
 ├───────────────────────────────────────┼──────────────────────────────────────┤
 │ rougail.var2                          │ An network in CIDR format.           │
-│  network   standard   mandatory       │ Default: 1.1.1.0/24                  │
+│  network   standard   mandatory       │ Validator: network must be in CIDR   │
+│                                       │ format                               │
+│                                       │ Default: 1.1.1.0/24                  │
 ├───────────────────────────────────────┼──────────────────────────────────────┤
 │ rougail.var3                          │ An network in CIDR format with       │
 │  network_cidr   standard   mandatory  │ obsolete CIDR type.                  │