From d55b12f0c4b860ebeed2cf4b96301b842ef2a0d7 Mon Sep 17 00:00:00 2001 From: Emmanuel Garette Date: Tue, 4 Nov 2025 19:22:23 +0100 Subject: [PATCH] [tutorial v1.1_043)] Jinja with a description (config and doc) --- README.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 2ecdcd81..6fc81892 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,9 @@ - [Summary](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/branch/1.1/README.md) -- [[tutorial v1.1_041] A conditional hidden family with Jinja](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_041/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_041~1..v1.1_041)) +- [[tutorial v1.1_042] Jinja with a parameter](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_042/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_042~1..v1.1_042)) -# [tutorial v1.1_042)] Jinja with a parameter +# [tutorial v1.1_043)] Jinja with a description -[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_042~1..v1.1_042) +[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_043~1..v1.1_043) ## Screenshot @@ -83,6 +83,7 @@ manual: {% if my_identifier == 'HTTPS' and manual.use_for_https %} HTTPS is same has HTTP {% endif %} + description: in HTTPS case if "manual.use_for_https" is set to True params: my_identifier: type: identifier @@ -105,7 +106,7 @@ manual: ### Let's generate the documentation ```console -foo@bar:~$ git switch --detach v1.1_042 +foo@bar:~$ git switch --detach v1.1_043 foo@bar:~$ rougail -m firefox/ -o doc -do github ``` | Variable                                                                                        | Description                                                                                     | @@ -143,7 +144,7 @@ This family builds families dynamically *`hidden`* -**Hidden**: depends on a calculation +**Hidden**: in HTTPS case if "manual.use_for_https" is set to True **Identifiers**:
- HTTPS
- SOCKS @@ -154,4 +155,4 @@ This family builds families dynamically -- [[tutorial v1.1_043] Jinja with a description](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_043/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_043~1..v1.1_043)) +- [[tutorial v1.1_044] A conditional disabled variable with identifier](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_044/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_044~1..v1.1_044))