No description

Find a file

Emmanuel Garette d332ca1707 [tutorial 020] Group variables inside a family The "manual" mode structural descriptions are write in a new files to separate things. But Rougail will concatenate variables and families. We create a family, which will contain other variables. This family has: - a description - a type As there is no variable inside this family, the type is mandatory. Without it, Rougail will create a variable. In fact, this family will be deleted by Rougail too because it is empty.		2025-11-04 19:22:07 +01:00
firefox	[tutorial 020] Group variables inside a family	2025-11-04 19:22:07 +01:00
firefox.png	[tutorial v1.1_020)] Group variables inside a family (config and doc)	2025-11-04 19:22:07 +01:00
foxyproxy.png	[init] Discover Rougail	2025-11-04 19:22:02 +01:00
README.md	[tutorial v1.1_020)] Group variables inside a family (config and doc)	2025-11-04 19:22:07 +01:00

README.md

[tutorial v1.1_020)] Group variables inside a family

View the diff

Screenshot

Structure

firefox/00-proxy.yml

%YAML 1.2
---
version: 1.1

proxy_mode:
  description: Configure Proxy Access to the Internet
  choices:
    - No proxy
    - Auto-detect proxy settings for this network
    - Use system proxy settings
    - Manual proxy configuration
    - Automatic proxy configuration URL
  default: No proxy
...

firefox/10-manual.yml

%YAML 1.2
---
version: 1.1

manual:
  description: Manual proxy configuration
  type: family
...

Let's generate the documentation

foo@bar:~$ git switch --detach v1.1_020
foo@bar:~$ rougail -m firefox/ -o doc -do github

Variable	Description
proxy_mode `choice` `mandatory`	Configure Proxy Access to the Internet. Choices: - No proxy ← (default) - Auto-detect proxy settings for this network - Use system proxy settings - Manual proxy configuration - Automatic proxy configuration URL

[tutorial v1.1_021] Group variables inside a sub family (diff)