stove/rougail
3
0
Fork 0
Code Issues 5 Pull requests 1 Projects Releases Wiki Activity

family -> reviewed

Browse source
This commit is contained in:
gwen 2025-12-04 18:26:08 +01:00
parent a9b6a00087
commit 921fc0f481
2 changed files with 11 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/naming_convention.rst
View file

@ -21,7 +21,7 @@ A file named :file:`firefox/00-proxy.yml` structure file and file named :file:`f
├── 00-proxy.yml ├── 00-proxy.yml
└── 10-manual.yml └── 10-manual.yml
.. note:: We could of course could have put everything in one file. .. note:: We of course could have put everything in one file.
Again, it is better to separate the structures in different files Again, it is better to separate the structures in different files
for reasons of ordering and clarity. for reasons of ordering and clarity.

12
docs/tutorial/family.rst
View file

@ -113,7 +113,7 @@ Or a sub family
A sub family is a family inside a family. A sub family is a family inside a family.
Creating a family hierarchy of family container types is very easy, here is an example: Creating a family hierarchy of families (family inside a family) is very easy:
.. extinclude:: https://forge.cloud.silique.fr/stove/rougail-tutorials/raw/tag/v1.1_021/firefox/10-manual.yml .. extinclude:: https://forge.cloud.silique.fr/stove/rougail-tutorials/raw/tag/v1.1_021/firefox/10-manual.yml
:language: yaml :language: yaml
@ -132,7 +132,15 @@ Creating a family hierarchy of family container types is very easy, here is an e
:tutorial:`Download this file from the rougail-tutorials git repository <src/tag/v1.1_021/firefox/00-proxy.yml>` :tutorial:`Download this file from the rougail-tutorials git repository <src/tag/v1.1_021/firefox/00-proxy.yml>`
Note that the `http_proxy` family lives inside the `manual` family. Here in our use case we used the :term:`short-hand declaration mode <short-hand notation>`
to declare our `manual` family:
.. code-block:: yaml
manual: # Manual proxy configuration
And the `http_proxy` family lives inside of this `manual` family.
We therefore created a hierarchy of families.
Putting a variable inside of a family or a sub family Putting a variable inside of a family or a sub family
----------------------------------------------------------- -----------------------------------------------------------