No description
Emmanuel Garette
c9312d3951
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). |
||
|---|---|---|
| firefox | ||
| firefox.png | ||
| foxyproxy.png | ||
| install.txt | ||
| README.md | ||
| tree.html | ||
[tutorial v1.1_021)] Or a sub family
Screenshot
Clone and install
To test this tutorial, you need to download this repository and install Rougail:
git clone -b 1.1 https://forge.cloud.silique.fr/stove/rougail-tutorials.git
cd rougail-tutorials
python -m venv venv_rougail
. venv_rougail/bin/activate
pip install rougail-cli rougail-output-exporter rougail-output-doc rougail-user-data-yaml
Then switch to the tutorial page:
git switch --detach v1.1_021
Structure
.
└── firefox
├── 00-proxy.yml
└── 10-manual.yml
Contents of the firefox/10-manual.yml file
%YAML 1.2
---
version: 1.1
manual: # Manual proxy configuration
http_proxy:
description: HTTP Proxy
type: family
...
Let's generate the documentation
rougail -m firefox/ -o doc
| Variable | Description |
|---|---|
proxy_modechoice 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 |