No description

Find a file

Emmanuel Garette 7b427c9897 [tutorial 021] Group variables inside a sub family Inside a family, we can have variables or families. The "type" for family "manual" became unecessary because container an other family, so it's not a variable. The description can now be has family comment. In disabled attribute, it's better tu use relative path (we will see the reason in an other slide).		2025-11-04 19:22:08 +01:00
firefox	[tutorial 021] Group variables inside a sub family	2025-11-04 19:22:08 +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_021)] Group variables inside a sub family (config and doc)	2025-11-04 19:22:08 +01:00

README.md

[tutorial v1.1_021)] Group variables inside a sub 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:  # Manual proxy configuration

  http_proxy:
    description: HTTP Proxy
    type: family
...

Let's generate the documentation

foo@bar:~$ git switch --detach v1.1_021
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_022] A variable inside sub family (diff)