stove/rougail-output-ansible
2
0
Fork 0
Code Issues 1 Pull requests Projects Releases Packages Wiki Activity Actions

feat: can change the directory where documentation are placed + remove empty vars/main.yml file + better tests

Browse source
This commit is contained in:
egarette@silique.fr 2026-06-15 08:50:13 +02:00
parent 00cdfae024
commit b9f6e16a16
1567 changed files with 11968 additions and 42 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
README.fr.md
View file

@ -46,6 +46,10 @@ include_toc: true
| **<a id="ansible.doc.playbooks.name" name="ansible.doc.playbooks.name">ansible.doc.playbooks.name</a>**<br/>**Ligne de commande** : <br/>--ansible.doc.playbooks.name<br/>**Variable d'environnement** : ROUGAILCLI_ANSIBLE.DOC.PLAYBOOKS.NAME | Nom du Playbook.<br/>Les Playbooks sont placés dans le répertoire playbooks/. Par défaut, la description du &quot;type&quot; est utilisée comme nom de Playbook dans l&#x27;exemple généré. Il est possible de personnalisé la description ici. | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` | `unique` | | **<a id="ansible.doc.playbooks.name" name="ansible.doc.playbooks.name">ansible.doc.playbooks.name</a>**<br/>**Ligne de commande** : <br/>--ansible.doc.playbooks.name<br/>**Variable d'environnement** : ROUGAILCLI_ANSIBLE.DOC.PLAYBOOKS.NAME | Nom du Playbook.<br/>Les Playbooks sont placés dans le répertoire playbooks/. Par défaut, la description du &quot;type&quot; est utilisée comme nom de Playbook dans l&#x27;exemple généré. Il est possible de personnalisé la description ici. | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` | `unique` |
| **<a id="ansible.doc.playbooks.description" name="ansible.doc.playbooks.description">ansible.doc.playbooks.description</a>**<br/>**Ligne de commande** : <br/>--ansible.doc.playbooks.description<br/>**Variable d'environnement** : ROUGAILCLI_ANSIBLE.DOC.PLAYBOOKS.DESCRIPTION | Description du Playbook. | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | | | **<a id="ansible.doc.playbooks.description" name="ansible.doc.playbooks.description">ansible.doc.playbooks.description</a>**<br/>**Ligne de commande** : <br/>--ansible.doc.playbooks.description<br/>**Variable d'environnement** : ROUGAILCLI_ANSIBLE.DOC.PLAYBOOKS.DESCRIPTION | Description du Playbook. | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | |
| Variable | Description | Type | Validateur |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------|-------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------|
| **<a id="ansible.doc.root_directory" name="ansible.doc.root_directory">ansible.doc.root_directory</a>**<br/>**Ligne de commande** : <br/>--ansible.doc.root_directory<br/>**Variable d'environnement** : ROUGAILCLI_ANSIBLE.DOC.ROOT_DIRECTORY | Répertoire racine de la documentation générée. | [`UNIX filename`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) | •&nbsp;le nom de fichier peut être une chemin relatif<br/>•&nbsp;le fichier doit exister<br/>•&nbsp;type de fichier autorisé: "directory". |
### Configuration de l&#x27;inventaire ### Configuration de l&#x27;inventaire
> [!NOTE] > [!NOTE]

4
README.md
View file

@ -46,6 +46,10 @@ include_toc: true
| **<a id="ansible.doc.playbooks.name" name="ansible.doc.playbooks.name">ansible.doc.playbooks.name</a>**<br/>**Command line**: <br/>--ansible.doc.playbooks.name<br/>**Environment variable**: ROUGAILCLI_ANSIBLE.DOC.PLAYBOOKS.NAME | Playbook name.<br/>Playbooks are placed in the playbooks/ directory. By default, the description of the &quot;type&quot; is used as the Playbook name in the generated example. It is possible to customize this description here. | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` | `unique` | | **<a id="ansible.doc.playbooks.name" name="ansible.doc.playbooks.name">ansible.doc.playbooks.name</a>**<br/>**Command line**: <br/>--ansible.doc.playbooks.name<br/>**Environment variable**: ROUGAILCLI_ANSIBLE.DOC.PLAYBOOKS.NAME | Playbook name.<br/>Playbooks are placed in the playbooks/ directory. By default, the description of the &quot;type&quot; is used as the Playbook name in the generated example. It is possible to customize this description here. | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` | `unique` |
| **<a id="ansible.doc.playbooks.description" name="ansible.doc.playbooks.description">ansible.doc.playbooks.description</a>**<br/>**Command line**: <br/>--ansible.doc.playbooks.description<br/>**Environment variable**: ROUGAILCLI_ANSIBLE.DOC.PLAYBOOKS.DESCRIPTION | Playbook description. | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | | | **<a id="ansible.doc.playbooks.description" name="ansible.doc.playbooks.description">ansible.doc.playbooks.description</a>**<br/>**Command line**: <br/>--ansible.doc.playbooks.description<br/>**Environment variable**: ROUGAILCLI_ANSIBLE.DOC.PLAYBOOKS.DESCRIPTION | Playbook description. | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | |
| Variable | Description | Type | Validator |
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------|-------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------|
| **<a id="ansible.doc.root_directory" name="ansible.doc.root_directory">ansible.doc.root_directory</a>**<br/>**Command line**: <br/>--ansible.doc.root_directory<br/>**Environment variable**: ROUGAILCLI_ANSIBLE.DOC.ROOT_DIRECTORY | Root directory of generated documents. | [`UNIX filename`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) | •&nbsp;this filename could be a relative path<br/>•&nbsp;this file must exist<br/>•&nbsp;file type allowed: "directory". |
### Inventory configuration ### Inventory configuration
> [!NOTE] > [!NOTE]

40
locale/fr/LC_MESSAGES/rougail_output_ansible.po
View file

@ -5,8 +5,8 @@
msgid "" msgid ""
msgstr "" msgstr ""
"Project-Id-Version: \n" "Project-Id-Version: \n"
"POT-Creation-Date: 2026-06-08 06:36+0200\n" "POT-Creation-Date: 2026-06-15 08:47+0200\n"
"PO-Revision-Date: 2026-06-08 06:36+0200\n" "PO-Revision-Date: 2026-06-15 08:48+0200\n"
"Last-Translator: \n" "Last-Translator: \n"
"Language-Team: \n" "Language-Team: \n"
"Language: fr\n" "Language: fr\n"
@ -127,73 +127,77 @@ msgid "Playbook description"
msgstr "Description du Playbook" msgstr "Description du Playbook"
#: src/rougail/output_ansible/config.py:129 #: src/rougail/output_ansible/config.py:129
msgid "Root directory of generated documents"
msgstr "Répertoire racine de la documentation générée"
#: src/rougail/output_ansible/config.py:139
msgid "Inventory configuration" msgid "Inventory configuration"
msgstr "Configuration de l'inventaire" msgstr "Configuration de l'inventaire"
#: src/rougail/output_ansible/config.py:134 #: src/rougail/output_ansible/config.py:144
msgid "Remove namespace name in host vars" msgid "Remove namespace name in host vars"
msgstr "Supprime le nom de l'espace de nom dans les vars de l'hôte" msgstr "Supprime le nom de l'espace de nom dans les vars de l'hôte"
#: src/rougail/output_ansible/config.py:136 #: src/rougail/output_ansible/config.py:146
msgid "Displays warnings inside Ansible exportation datas" msgid "Displays warnings inside Ansible exportation datas"
msgstr "Affiche les avertissements dans les données d'exportation Ansible" msgstr "Affiche les avertissements dans les données d'exportation Ansible"
#: src/rougail/output_ansible/doc.py:94 #: src/rougail/output_ansible/doc.py:101
msgid "This repository contains the {0} Ansible collection." msgid "This repository contains the {0} Ansible collection."
msgstr "Le dépôt contient la collection Ansible {0}." msgstr "Le dépôt contient la collection Ansible {0}."
#: src/rougail/output_ansible/doc.py:101 #: src/rougail/output_ansible/doc.py:108
msgid "The group variables \"{0}\" - {1}" msgid "The group variables \"{0}\" - {1}"
msgstr "Le groupe de variables \"{0}\" - {1}" msgstr "Le groupe de variables \"{0}\" - {1}"
#: src/rougail/output_ansible/doc.py:103 #: src/rougail/output_ansible/doc.py:110
msgid "The group variables {0}" msgid "The group variables {0}"
msgstr "Le groupe de variables {0}" msgstr "Le groupe de variables {0}"
#: src/rougail/output_ansible/doc.py:108 #: src/rougail/output_ansible/doc.py:115
msgid "Variables" msgid "Variables"
msgstr "Variables" msgstr "Variables"
#: src/rougail/output_ansible/doc.py:128 #: src/rougail/output_ansible/doc.py:135
msgid "Usage" msgid "Usage"
msgstr "Usage" msgstr "Usage"
#: src/rougail/output_ansible/doc.py:129 #: src/rougail/output_ansible/doc.py:136
msgid "Example Playbook with Rougail" msgid "Example Playbook with Rougail"
msgstr "Exemple de playbook avec Rougail" msgstr "Exemple de playbook avec Rougail"
#: src/rougail/output_ansible/doc.py:137 #: src/rougail/output_ansible/doc.py:144
msgid "Add to your structural file something like:" msgid "Add to your structural file something like:"
msgstr "Ajouter à votre fichier de structure quelque chose comme :" msgstr "Ajouter à votre fichier de structure quelque chose comme :"
#: src/rougail/output_ansible/doc.py:141 #: src/rougail/output_ansible/doc.py:148
msgid "Customizing hidden variables in structure file:" msgid "Customizing hidden variables in structure file:"
msgstr "Variables personnalisées cachées dans les fichier de structure :" msgstr "Variables personnalisées cachées dans les fichier de structure :"
#: src/rougail/output_ansible/doc.py:144 #: src/rougail/output_ansible/doc.py:151
msgid "Do not forget to add Rougail structure file as Rougail types." msgid "Do not forget to add Rougail structure file as Rougail types."
msgstr "" msgstr ""
"Ne pas oublier d'ajouter le fichier de structure Rougail comme types Rougail." "Ne pas oublier d'ajouter le fichier de structure Rougail comme types Rougail."
#: src/rougail/output_ansible/doc.py:151 #: src/rougail/output_ansible/doc.py:158
msgid "For example you can add an YAML user data with something like:" msgid "For example you can add an YAML user data with something like:"
msgstr "" msgstr ""
"Par exemple vous pouvez ajouter une donnée utilisateur de type YAML avec " "Par exemple vous pouvez ajouter une donnée utilisateur de type YAML avec "
"quelque chose comme :" "quelque chose comme :"
#: src/rougail/output_ansible/doc.py:153 #: src/rougail/output_ansible/doc.py:160
msgid "Add to your Play:" msgid "Add to your Play:"
msgstr "Ajouter à votre Play :" msgstr "Ajouter à votre Play :"
#: src/rougail/output_ansible/doc.py:168 #: src/rougail/output_ansible/doc.py:175
msgid "Example Playbook without Rougail" msgid "Example Playbook without Rougail"
msgstr "Exemple de Playbook sans Rougail" msgstr "Exemple de Playbook sans Rougail"
#: src/rougail/output_ansible/doc.py:169 #: src/rougail/output_ansible/doc.py:176
msgid "The variables will not be properly validated without Rougail." msgid "The variables will not be properly validated without Rougail."
msgstr "Les variables ne seront pas validées correctement sans Rougail." msgstr "Les variables ne seront pas validées correctement sans Rougail."
#: src/rougail/output_ansible/doc.py:221 #: src/rougail/output_ansible/doc.py:228
msgid "" msgid ""
"Unable to find a Playbook in playbooks/ directory or a role in roles/ " "Unable to find a Playbook in playbooks/ directory or a role in roles/ "
"directory" "directory"

38
locale/rougail_output_ansible.pot
View file

@ -5,7 +5,7 @@
msgid "" msgid ""
msgstr "" msgstr ""
"Project-Id-Version: PACKAGE VERSION\n" "Project-Id-Version: PACKAGE VERSION\n"
"POT-Creation-Date: 2026-06-11 21:35+0200\n" "POT-Creation-Date: 2026-06-15 08:48+0200\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n" "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\n" "Language-Team: LANGUAGE <LL@li.org>\n"
@ -113,70 +113,74 @@ msgid "Playbook description"
msgstr "" msgstr ""
#: src/rougail/output_ansible/config.py:129 #: src/rougail/output_ansible/config.py:129
msgid "Root directory of generated documents"
msgstr ""
#: src/rougail/output_ansible/config.py:139
msgid "Inventory configuration" msgid "Inventory configuration"
msgstr "" msgstr ""
#: src/rougail/output_ansible/config.py:134 #: src/rougail/output_ansible/config.py:144
msgid "Remove namespace name in host vars" msgid "Remove namespace name in host vars"
msgstr "" msgstr ""
#: src/rougail/output_ansible/config.py:136 #: src/rougail/output_ansible/config.py:146
msgid "Displays warnings inside Ansible exportation datas" msgid "Displays warnings inside Ansible exportation datas"
msgstr "" msgstr ""
#: src/rougail/output_ansible/doc.py:96 #: src/rougail/output_ansible/doc.py:101
msgid "This repository contains the {0} Ansible collection." msgid "This repository contains the {0} Ansible collection."
msgstr "" msgstr ""
#: src/rougail/output_ansible/doc.py:103 #: src/rougail/output_ansible/doc.py:108
msgid "The group variables \"{0}\" - {1}" msgid "The group variables \"{0}\" - {1}"
msgstr "" msgstr ""
#: src/rougail/output_ansible/doc.py:105 #: src/rougail/output_ansible/doc.py:110
msgid "The group variables {0}" msgid "The group variables {0}"
msgstr "" msgstr ""
#: src/rougail/output_ansible/doc.py:110 #: src/rougail/output_ansible/doc.py:115
msgid "Variables" msgid "Variables"
msgstr "" msgstr ""
#: src/rougail/output_ansible/doc.py:130 #: src/rougail/output_ansible/doc.py:135
msgid "Usage" msgid "Usage"
msgstr "" msgstr ""
#: src/rougail/output_ansible/doc.py:131 #: src/rougail/output_ansible/doc.py:136
msgid "Example Playbook with Rougail" msgid "Example Playbook with Rougail"
msgstr "" msgstr ""
#: src/rougail/output_ansible/doc.py:139 #: src/rougail/output_ansible/doc.py:144
msgid "Add to your structural file something like:" msgid "Add to your structural file something like:"
msgstr "" msgstr ""
#: src/rougail/output_ansible/doc.py:143 #: src/rougail/output_ansible/doc.py:148
msgid "Customizing hidden variables in structure file:" msgid "Customizing hidden variables in structure file:"
msgstr "" msgstr ""
#: src/rougail/output_ansible/doc.py:146 #: src/rougail/output_ansible/doc.py:151
msgid "Do not forget to add Rougail structure file as Rougail types." msgid "Do not forget to add Rougail structure file as Rougail types."
msgstr "" msgstr ""
#: src/rougail/output_ansible/doc.py:153 #: src/rougail/output_ansible/doc.py:158
msgid "For example you can add an YAML user data with something like:" msgid "For example you can add an YAML user data with something like:"
msgstr "" msgstr ""
#: src/rougail/output_ansible/doc.py:155 #: src/rougail/output_ansible/doc.py:160
msgid "Add to your Play:" msgid "Add to your Play:"
msgstr "" msgstr ""
#: src/rougail/output_ansible/doc.py:170 #: src/rougail/output_ansible/doc.py:175
msgid "Example Playbook without Rougail" msgid "Example Playbook without Rougail"
msgstr "" msgstr ""
#: src/rougail/output_ansible/doc.py:171 #: src/rougail/output_ansible/doc.py:176
msgid "The variables will not be properly validated without Rougail." msgid "The variables will not be properly validated without Rougail."
msgstr "" msgstr ""
#: src/rougail/output_ansible/doc.py:223 #: src/rougail/output_ansible/doc.py:228
msgid "Unable to find a Playbook in playbooks/ directory or a role in roles/ directory" msgid "Unable to find a Playbook in playbooks/ directory or a role in roles/ directory"
msgstr "" msgstr ""

10
src/rougail/output_ansible/config.py
View file

@ -125,6 +125,16 @@ ansible:
description: # {_('Playbook description')} description: # {_('Playbook description')}
root_directory:
description: {_('Root directory of generated documents')}
type: unix_filename
params:
allow_relative: true
test_existence: true
types:
- directory
mandatory: false
inventory: inventory:
description: {_("Inventory configuration")} description: {_("Inventory configuration")}
disabled: disabled:

17
src/rougail/output_ansible/doc.py
View file

@ -67,6 +67,11 @@ class Doc(RougailOutputDoc):
self.root_config = self.config self.root_config = self.config
self.load() self.load()
self.load_formatter() self.load_formatter()
self.root_directory = self.ori_rougailconfig["ansible.doc.root_directory"]
if self.root_directory is None:
self.root_directory = Path(".")
else:
self.root_directory = Path(self.root_directory)
config = self._build_example_config() config = self._build_example_config()
examples = self._gen_doc_examples(config, True) examples = self._gen_doc_examples(config, True)
config.property.read_only() config.property.read_only()
@ -186,7 +191,7 @@ class Doc(RougailOutputDoc):
done = False done = False
if self.collection_type != "roles": if self.collection_type != "roles":
playbooks = dict(self.ori_rougailconfig["ansible.doc.playbooks"].items()) playbooks = dict(self.ori_rougailconfig["ansible.doc.playbooks"].items())
playbooks_dir = Path("playbooks") playbooks_dir = self.root_directory / "playbooks"
if playbooks_dir.is_dir(): if playbooks_dir.is_dir():
lst = [] lst = []
for playbook in playbooks_dir.iterdir(): for playbook in playbooks_dir.iterdir():
@ -206,7 +211,7 @@ class Doc(RougailOutputDoc):
yaml["ansible.builtin.import_playbook"] = playbook_import yaml["ansible.builtin.import_playbook"] = playbook_import
lst.append(yaml) lst.append(yaml)
if self.collection_type != "playbooks" and not done: if self.collection_type != "playbooks" and not done:
roles_dir = Path("roles") roles_dir = self.root_directory / "roles"
if roles_dir.is_dir(): if roles_dir.is_dir():
yaml = {"name": description, yaml = {"name": description,
"hosts": "servers", "hosts": "servers",
@ -227,19 +232,19 @@ class Doc(RougailOutputDoc):
values = config.value.get() values = config.value.get()
results = CommentedMap() results = CommentedMap()
self._example_parse_family(values, results, dump_type="default") self._example_parse_family(values, results, dump_type="default")
if not results:
return
self._build_write("defaults", results) self._build_write("defaults", results)
def _build_vars(self, results): def _build_vars(self, results):
self._build_write("vars", results) self._build_write("vars", results)
def _build_write(self, write_type, results): def _build_write(self, write_type, results):
role_dir = Path("roles") / self.ansible_name if not results:
return
role_dir = self.root_directory / "roles" / self.ansible_name
if role_dir.is_dir(): if role_dir.is_dir():
filedir = role_dir / write_type filedir = role_dir / write_type
else: else:
filedir = Path(write_type) filedir = self.root_directory / write_type
filedir.mkdir(exist_ok=True) filedir.mkdir(exist_ok=True)
with (filedir / "main.yml").open('w') as fh: with (filedir / "main.yml").open('w') as fh:
fh.write(f"---\n{dump(results)}\n") fh.write(f"---\n{dump(results)}\n")

BIN
src/rougail/output_ansible/locale/fr/LC_MESSAGES/rougail_output_ansible.mo
View file

Binary file not shown.

0
playbooks/install.yml → tests/playbooks/install.yml
View file

3
tests/results-doc/test_namespace/00_0version_underscore.ansible/vars/main.yml Normal file
View file

@ -0,0 +1,3 @@
---
rougail: # Rougail
version: string1 # A variable

3
tests/results-doc/test_namespace/00_1empty_variable.ansible/vars/main.yml Normal file
View file

@ -0,0 +1,3 @@
---
rougail: # Rougail
empty: string1

5
tests/results-doc/test_namespace/00_2default_calculated.ansible/defaults/main.yml Normal file
View file

@ -0,0 +1,5 @@
---
rougail: # Rougail
var1: no # A first variable
var2: # A second variable
- no

10
tests/results-doc/test_namespace/00_2default_calculated_multi.ansible/defaults/main.yml Normal file
View file

@ -0,0 +1,10 @@
---
rougail: # Rougail
var1: # A first variable
- no
- yes
- maybe
var2: # A second variable
- no
- yes
- maybe

3
tests/results-doc/test_namespace/00_2default_calculated_params_permissive.ansible/defaults/main.yml Normal file
View file

@ -0,0 +1,3 @@
---
rougail: # Rougail
var2: a_value # A second variable

5
tests/results-doc/test_namespace/00_2default_calculated_variable.ansible/defaults/main.yml Normal file
View file

@ -0,0 +1,5 @@
---
rougail: # Rougail
var2: # A second variable
- domain1.lan
- domain2.lan

5
tests/results-doc/test_namespace/00_2default_calculated_variable.ansible/vars/main.yml Normal file
View file

@ -0,0 +1,5 @@
---
rougail: # Rougail
var1: # A first variable
- domain1.lan
- domain2.lan

3
tests/results-doc/test_namespace/00_2default_calculated_variable_description.ansible/defaults/main.yml Normal file
View file

@ -0,0 +1,3 @@
---
rougail: # Rougail
var2: string1 # A second variable

3
tests/results-doc/test_namespace/00_2default_calculated_variable_description.ansible/vars/main.yml Normal file
View file

@ -0,0 +1,3 @@
---
rougail: # Rougail
var1: string1 # A first variable

3
tests/results-doc/test_namespace/00_2default_calculated_variable_description_multi_line.ansible/defaults/main.yml Normal file
View file

@ -0,0 +1,3 @@
---
rougail: # Rougail
var2: string1 # A second variable

4
tests/results-doc/test_namespace/00_2default_calculated_variable_description_multi_line.ansible/vars/main.yml Normal file
View file

@ -0,0 +1,4 @@
---
rougail: # Rougail
var1: string1 # A first variable
var3: string1 # A new variable

5
tests/results-doc/test_namespace/00_2default_calculated_variable_transitive.ansible/defaults/main.yml Normal file
View file

@ -0,0 +1,5 @@
---
rougail: # Rougail
var2: # A second variable
- domain1.lan
- domain2.lan

5
tests/results-doc/test_namespace/00_2default_calculated_variable_transitive.ansible/vars/main.yml Normal file
View file

@ -0,0 +1,5 @@
---
rougail: # Rougail
var1: # A first variable
- domain1.lan
- domain2.lan

4
tests/results-doc/test_namespace/00_4load_subfolder.ansible/vars/main.yml Normal file
View file

@ -0,0 +1,4 @@
---
rougail: # Rougail
var1: string1 # A variable
var2: string1 # A variable

3
tests/results-doc/test_namespace/00_5load_notype.ansible/defaults/main.yml Normal file
View file

@ -0,0 +1,3 @@
---
rougail: # Rougail
without_type: non # A variable

8
tests/results-doc/test_namespace/00_6boolean.ansible/defaults/main.yml Normal file
View file

@ -0,0 +1,8 @@
---
rougail: # Rougail
var1: true # The first variable
var2: true # The second variable
var3: true # The third variable
var4: false # The forth variable
var5: false # The fifth variable
var6: false # The sixth variable

3
tests/results-doc/test_namespace/00_6boolean_no_mandatory.ansible/defaults/main.yml Normal file
View file

@ -0,0 +1,3 @@
---
rougail: # Rougail
variable: true # A variable

6
tests/results-doc/test_namespace/00_6choice.ansible/defaults/main.yml Normal file
View file

@ -0,0 +1,6 @@
---
rougail: # Rougail
var3: null # The third variable
var4: null # The forth variable
var5: a # The fifth variable
var6: 1 # The sixth variable

4
tests/results-doc/test_namespace/00_6choice.ansible/vars/main.yml Normal file
View file

@ -0,0 +1,4 @@
---
rougail: # Rougail
var1: a # The first variable
var2: a # The second variable

3
tests/results-doc/test_namespace/00_6choice_calculation.ansible/defaults/main.yml Normal file
View file

@ -0,0 +1,3 @@
---
rougail: # Rougail
var: 9 # A variable

3
tests/results-doc/test_namespace/00_6choice_link.ansible/defaults/main.yml Normal file
View file

@ -0,0 +1,3 @@
---
rougail: # Rougail
var2: a # The second variable

3
tests/results-doc/test_namespace/00_6choice_link.ansible/vars/main.yml Normal file
View file

@ -0,0 +1,3 @@
---
rougail: # Rougail
var1: a # The first variable

7
tests/results-doc/test_namespace/00_6choice_variable.ansible/defaults/main.yml Normal file
View file

@ -0,0 +1,7 @@
---
rougail: # Rougail
var1: # A second variable
- a
- b
- c
var2: a # A first variable

8
tests/results-doc/test_namespace/00_6choice_variable_link.ansible/defaults/main.yml Normal file
View file

@ -0,0 +1,8 @@
---
rougail: # Rougail
var1: # A second variable
- a
- b
- c
var2: a # A first variable
var3: a # A third variable

9
tests/results-doc/test_namespace/00_6choice_variable_link2.ansible/defaults/main.yml Normal file
View file

@ -0,0 +1,9 @@
---
rougail: # Rougail
var1: # A second variable
- a
- b
- c
var2: a # A first variable
family:
var3: a # A third variable

3
tests/results-doc/test_namespace/00_6custom.ansible/defaults/main.yml Normal file
View file

@ -0,0 +1,3 @@
---
rougail: # Rougail
custom2: value # The seconf variable

3
tests/results-doc/test_namespace/00_6custom.ansible/vars/main.yml Normal file
View file

@ -0,0 +1,3 @@
---
rougail: # Rougail
custom1: string1 # The first variable

3
tests/results-doc/test_namespace/00_6domainname.ansible/defaults/main.yml Normal file
View file

@ -0,0 +1,3 @@
---
rougail: # Rougail
variable: my.domain.name # A domain name variable

3
tests/results-doc/test_namespace/00_6domainname_params.ansible/defaults/main.yml Normal file
View file

@ -0,0 +1,3 @@
---
rougail: # Rougail
variable: my.domain.name # A domain name variable

8
tests/results-doc/test_namespace/00_6float.ansible/defaults/main.yml Normal file
View file

@ -0,0 +1,8 @@
---
rougail: # Rougail
var1: 0.0 # The first variable
var2: 0.0 # The second variable
var3: 0.0 # The third variable
var4: 10.1 # The forth variable
var5: 10.1 # The fifth variable
var6: 10.1 # The sixth variable

8
tests/results-doc/test_namespace/00_6integer.ansible/defaults/main.yml Normal file
View file

@ -0,0 +1,8 @@
---
rougail: # Rougail
var1: 0 # The first variable
var2: 0 # The second variable
var3: 0 # The third variable
var4: 10 # This forth variable
var5: 10 # The fifth variable
var6: 10 # The sixth variable

5
tests/results-doc/test_namespace/00_6ip.ansible/defaults/main.yml Normal file
View file

@ -0,0 +1,5 @@
---
rougail: # Rougail
var1: 1.1.1.1 # An IP
var2: 1.1.1.1/24 # An IP in CIDR format
var3: 1.1.1.1/24 # An IP in CIDR format with obsolete CIDR type

5
tests/results-doc/test_namespace/00_6network.ansible/defaults/main.yml Normal file
View file

@ -0,0 +1,5 @@
---
rougail: # Rougail
var1: 1.1.1.0 # An network
var2: 1.1.1.0/24 # An network in CIDR format
var3: 1.1.1.0/24 # An network in CIDR format with obsolete CIDR type

8
tests/results-doc/test_namespace/00_6number.ansible/defaults/main.yml Normal file
View file

@ -0,0 +1,8 @@
---
rougail: # Rougail
var1: 0 # The first variable
var2: 0 # The second variable
var3: 0 # The third variable
var4: 10 # This forth variable
var5: 10 # The fifth variable
var6: 10 # The sixth variable

4
tests/results-doc/test_namespace/00_6port.ansible/defaults/main.yml Normal file
View file

@ -0,0 +1,4 @@
---
rougail: # Rougail
variable2: '8080' # A port variable with default value
variable3: '8080' # A port variable with integer default value

3
tests/results-doc/test_namespace/00_6port.ansible/vars/main.yml Normal file
View file

@ -0,0 +1,3 @@
---
rougail: # Rougail
variable1: '80' # A port variable

3
tests/results-doc/test_namespace/00_6regexp.ansible/defaults/main.yml Normal file
View file

@ -0,0 +1,3 @@
---
rougail: # Rougail
var: '#a1a1a1' # A first variable

4
tests/results-doc/test_namespace/00_6regexp_link.ansible/defaults/main.yml Normal file
View file

@ -0,0 +1,4 @@
---
rougail: # Rougail
var1: '#a1a1a1' # A first variable
var2: '#a1a1a1' # A second variable

3
tests/results-doc/test_namespace/00_6secret.ansible/defaults/main.yml Normal file
View file

@ -0,0 +1,3 @@
---
rougail: # Rougail
secret2: value # The second variable

3
tests/results-doc/test_namespace/00_6secret.ansible/vars/main.yml Normal file
View file

@ -0,0 +1,3 @@
---
rougail: # Rougail
secret1: onE7vaLues_len1 # The first variable

4
tests/results-doc/test_namespace/00_6secret_param.ansible/defaults/main.yml Normal file
View file

@ -0,0 +1,4 @@
---
rougail: # Rougail
secret2: value # The second variable
secret3: value # The third variable

3
tests/results-doc/test_namespace/00_6secret_param.ansible/vars/main.yml Normal file
View file

@ -0,0 +1,3 @@
---
rougail: # Rougail
secret1: onE7vaLues_len1 # The first variable

7
tests/results-doc/test_namespace/00_6string.ansible/defaults/main.yml Normal file
View file

@ -0,0 +1,7 @@
---
rougail: # Rougail
var4: value # The forth variable
var5: value # The fifth variable
var6: value # The sixth variable
var7: '8080' # The seventh variable
var8: 'true' # The height variable

5
tests/results-doc/test_namespace/00_6string.ansible/vars/main.yml Normal file
View file

@ -0,0 +1,5 @@
---
rougail: # Rougail
var1: string1 # The first variable
var2: string1 # The second variable
var3: string1 # The third variable

3
tests/results-doc/test_namespace/00_7choice_quote.ansible/defaults/main.yml Normal file
View file

@ -0,0 +1,3 @@
---
rougail: # Rougail
var: quote' # A choice

4
tests/results-doc/test_namespace/00_7help.ansible/vars/main.yml Normal file
View file

@ -0,0 +1,4 @@
---
rougail: # Rougail
var1: string1 # The first variable
var2: string1 # The second variable

4
tests/results-doc/test_namespace/00_7help_quote.ansible/vars/main.yml Normal file
View file

@ -0,0 +1,4 @@
---
rougail: # Rougail
var1: string1 # The first variable
var2: string1 # The second variable

4
tests/results-doc/test_namespace/00_7help_sup.ansible/vars/main.yml Normal file
View file

@ -0,0 +1,4 @@
---
rougail: # Rougail
var1: string1 # The first <variable>
var2: string1 # The second <variable>

3
tests/results-doc/test_namespace/00_7value_doublequote.ansible/defaults/main.yml Normal file
View file

@ -0,0 +1,3 @@
---
rougail: # Rougail
variable: quote" # A variable

3
tests/results-doc/test_namespace/00_7value_doublequote2.ansible/defaults/main.yml Normal file
View file

@ -0,0 +1,3 @@
---
rougail: # Rougail
variable: quote'" # A variable

3
tests/results-doc/test_namespace/00_7value_doublequote3.ansible/defaults/main.yml Normal file
View file

@ -0,0 +1,3 @@
---
rougail: # Rougail
variable: quote\"\' # A variable

3
tests/results-doc/test_namespace/00_7value_quote.ansible/defaults/main.yml Normal file
View file

@ -0,0 +1,3 @@
---
rougail: # Rougail
variable: quote' # A variable

3
tests/results-doc/test_namespace/00_8calculation_information.ansible/vars/main.yml Normal file
View file

@ -0,0 +1,3 @@
---
rougail: # Rougail
variable: string1 # A variable

3
tests/results-doc/test_namespace/00_8calculation_namespace.ansible/defaults/main.yml Normal file
View file

@ -0,0 +1,3 @@
---
rougail: # Rougail
variable: Rougail # A variable

3
tests/results-doc/test_namespace/00_8calculation_param_namespace.ansible/defaults/main.yml Normal file
View file

@ -0,0 +1,3 @@
---
rougail: # Rougail
variable: Rougail # A variable

5
tests/results-doc/test_namespace/00_8test.ansible/defaults/main.yml Normal file
View file

@ -0,0 +1,5 @@
---
rougail: # Rougail
var2: value # The second variable
var4: null # The forth variable
var5: true # The fifth variable

7
tests/results-doc/test_namespace/00_8test.ansible/vars/main.yml Normal file
View file

@ -0,0 +1,7 @@
---
rougail: # Rougail
var1: test # The first variable
var3: test1 # The third variable
var6: # The sixth variable
- test1
- test2

3
tests/results-doc/test_namespace/00_9choice_variable_multi.ansible/defaults/main.yml Normal file
View file

@ -0,0 +1,3 @@
---
rougail: # Rougail
variable2: [] # A second variable

5
tests/results-doc/test_namespace/00_9choice_variable_multi.ansible/vars/main.yml Normal file
View file

@ -0,0 +1,5 @@
---
rougail: # Rougail
variable1: # A first variable
- val1
- val2

5
tests/results-doc/test_namespace/00_9choice_variables.ansible/defaults/main.yml Normal file
View file

@ -0,0 +1,5 @@
---
rougail: # Rougail
source_variable_1: val1 # The first source variable
source_variable_2: val2 # The second source variable
my_variable: val1 # A variable

3
tests/results-doc/test_namespace/00_9default_calculation.ansible/defaults/main.yml Normal file
View file

@ -0,0 +1,3 @@
---
rougail: # Rougail
variable: string_1_True_None # A variable

3
tests/results-doc/test_namespace/00_9default_calculation_information.ansible/vars/main.yml Normal file
View file

@ -0,0 +1,3 @@
---
rougail: # Rougail
var: string1 # A variable

4
tests/results-doc/test_namespace/00_9default_calculation_information_other_variable.ansible/vars/main.yml Normal file
View file

@ -0,0 +1,4 @@
---
rougail: # Rougail
var1: string1 # A first variable
var2: string1 # A second variable

5
tests/results-doc/test_namespace/00_9default_calculation_multi_optional.ansible/defaults/main.yml Normal file
View file

@ -0,0 +1,5 @@
---
rougail: # Rougail
my_variable: val1
my_calculated_variable:
- val1

5
tests/results-doc/test_namespace/00_9default_calculation_multi_optional2.ansible/defaults/main.yml Normal file
View file

@ -0,0 +1,5 @@
---
rougail: # Rougail
my_variable: val1
my_calculated_variable:
- val1

6
tests/results-doc/test_namespace/00_9default_calculation_multi_optional_default.ansible/defaults/main.yml Normal file
View file

@ -0,0 +1,6 @@
---
rougail: # Rougail
my_variable: val1
my_calculated_variable:
- val1
- value

6
tests/results-doc/test_namespace/00_9default_calculation_optional.ansible/vars/main.yml Normal file
View file

@ -0,0 +1,6 @@
---
rougail: # Rougail
my_calculated_variable:
- string1
- string2
- string3

8
tests/results-doc/test_namespace/00_9default_calculation_optional_exists.ansible/defaults/main.yml Normal file
View file

@ -0,0 +1,8 @@
---
rougail: # Rougail
my_variable:
- val1
- val2
my_calculated_variable:
- val1
- val2

4
tests/results-doc/test_namespace/00_9default_calculation_param_optional.ansible/defaults/main.yml Normal file
View file

@ -0,0 +1,4 @@
---
rougail: # Rougail
var1: no # A first variable
var2: no # A second variable

4
tests/results-doc/test_namespace/00_9default_information_other_variable.ansible/vars/main.yml Normal file
View file

@ -0,0 +1,4 @@
---
rougail: # Rougail
var1: string1 # A first variable
var2: string1 # A second variable

4
tests/results-doc/test_namespace/00_9default_information_other_variable2.ansible/vars/main.yml Normal file
View file

@ -0,0 +1,4 @@
---
rougail: # Rougail
var1: string1 # A first variable
var2: string1 # A second variable

3
tests/results-doc/test_namespace/00_9default_integer.ansible/defaults/main.yml Normal file
View file

@ -0,0 +1,3 @@
---
rougail: # Rougail
var: 9 # A variable

3
tests/results-doc/test_namespace/00_9default_number.ansible/defaults/main.yml Normal file
View file

@ -0,0 +1,3 @@
---
rougail: # Rougail
var: 9 # A variable

18
tests/results-doc/test_namespace/01_6boolean_multi.ansible/defaults/main.yml Normal file
View file

@ -0,0 +1,18 @@
---
rougail: # Rougail
var1: # The first variable
- true
var2: # The second variable
- true
var3: # The third variable
- true
var4: # The forth variable
- false
var5: # The fifth variable
- false
var6: # The sixth variable
- false
var7: # The seventh variable
- true
var8: # The eighth variable
- true

4
tests/results-doc/test_namespace/01_6custom_multi.ansible/defaults/main.yml Normal file
View file

@ -0,0 +1,4 @@
---
rougail: # Rougail
custom2: # A second custom variable
- value

6
tests/results-doc/test_namespace/01_6custom_multi.ansible/vars/main.yml Normal file
View file

@ -0,0 +1,6 @@
---
rougail: # Rougail
custom1: # A first custom variable
- string1
- string2
- string3

18
tests/results-doc/test_namespace/01_6float_multi.ansible/defaults/main.yml Normal file
View file

@ -0,0 +1,18 @@
---
rougail: # Rougail
var1: # The first variable
- 0.0
var2: # The second variable
- 0.0
var3: # The third variable
- 0.0
var4: # The forth variable
- 10.1
var5: # The fifth variable
- 10.1
var6: # The sixth variable
- 10.1
var7: # The seventh variable
- 0.0
var8: # The eighth variable
- 0.0

18
tests/results-doc/test_namespace/01_6integer_multi.ansible/defaults/main.yml Normal file
View file

@ -0,0 +1,18 @@
---
rougail: # Rougail
var1: # The first variable
- 0
var2: # The second variable
- 0
var3: # The third variable
- 0
var4: # The forth variable
- 10
var5: # The fifth variable
- 10
var6: # The sixth variable
- 10
var7: # The seventh variable
- 0
var8: # The eighth variable
- 0

6
tests/results-doc/test_namespace/01_6integer_multi_mandatory.ansible/vars/main.yml Normal file
View file

@ -0,0 +1,6 @@
---
rougail: # Rougail
var: # The first variable
- 1
- 2
- 3

5
tests/results-doc/test_namespace/01_6string_empty.ansible/defaults/main.yml Normal file
View file

@ -0,0 +1,5 @@
---
rougail: # Rougail
var1: # The second variable
- value
- null

12
tests/results-doc/test_namespace/01_6string_multi.ansible/defaults/main.yml Normal file
View file

@ -0,0 +1,12 @@
---
rougail: # Rougail
var4: # The forth variable
- value
var5: # The fifth variable
- value
var6: # The sixth variable
- value
var7: # The seventh variable
- value
var8: # The eighth variable
- value

14
tests/results-doc/test_namespace/01_6string_multi.ansible/vars/main.yml Normal file
View file

@ -0,0 +1,14 @@
---
rougail: # Rougail
var1: # The first variable
- string1
- string2
- string3
var2: # The second variable
- string1
- string2
- string3
var3: # The third variable
- string1
- string2
- string3

9
tests/results-doc/test_namespace/01_6string_multi_length.ansible/defaults/main.yml Normal file
View file

@ -0,0 +1,9 @@
---
rougail: # Rougail
var1: # The variable
- val1
- val2
- val3
var2: # The variable
- val4
- val5

4
tests/results-doc/test_namespace/01_7value_multi_doublequote.ansible/defaults/main.yml Normal file
View file

@ -0,0 +1,4 @@
---
rougail: # Rougail
variable: # A variable
- quote"

4
tests/results-doc/test_namespace/01_7value_multi_doublequote2.ansible/defaults/main.yml Normal file
View file

@ -0,0 +1,4 @@
---
rougail: # Rougail
variable: # A variable
- quote'"

4
tests/results-doc/test_namespace/01_7value_multi_quote.ansible/defaults/main.yml Normal file
View file

@ -0,0 +1,4 @@
---
rougail: # Rougail
variable: # A variable
- quote'

6
tests/results-doc/test_namespace/01_8calculation_information_multi.ansible/vars/main.yml Normal file
View file

@ -0,0 +1,6 @@
---
rougail: # Rougail
variable: # A variable
- string1
- string2
- string3

6
tests/results-doc/test_namespace/01_9choice_variable_multi.ansible/defaults/main.yml Normal file
View file

@ -0,0 +1,6 @@
---
rougail: # Rougail
variable1: # A first variable
- a
- b
- c

3
tests/results-doc/test_namespace/01_9choice_variable_multi.ansible/vars/main.yml Normal file
View file

@ -0,0 +1,3 @@
---
rougail: # Rougail
variable2: a # A second variable

3
tests/results-doc/test_namespace/01_9choice_variable_optional.ansible/defaults/main.yml Normal file
View file

@ -0,0 +1,3 @@
---
rougail: # Rougail
variable: c # A variable

4
tests/results-doc/test_namespace/02_0tags.ansible/vars/main.yml Normal file
View file

@ -0,0 +1,4 @@
---
rougail: # Rougail
var1: string1 # The first variable
var2: string1 # The second variable

3
tests/results-doc/test_namespace/04_0type_param.ansible/defaults/main.yml Normal file
View file

@ -0,0 +1,3 @@
---
rougail: # Rougail
int: 10 # A limited number

Some files were not shown because too many files have changed in this diff Show more