doc output
This commit is contained in:
parent
f85d95e599
commit
480b5dbafb
1 changed files with 72 additions and 3 deletions
|
|
@ -311,7 +311,7 @@ With this rougail command:
|
||||||
|
|
||||||
rougail -m firefox -o doc --doc.output_format html > readme.html
|
rougail -m firefox -o doc --doc.output_format html > readme.html
|
||||||
|
|
||||||
We have an HTML report that contains:
|
It outputs an HTML report, here is a part of it:
|
||||||
|
|
||||||
.. code-block:: html
|
.. code-block:: html
|
||||||
|
|
||||||
|
|
@ -330,10 +330,11 @@ We have an HTML report that contains:
|
||||||
<ul><li>HTTPS</li>
|
<ul><li>HTTPS</li>
|
||||||
<li>SOCKS</li></ul>
|
<li>SOCKS</li></ul>
|
||||||
|
|
||||||
We can see that we have for the `manual.https_proxy` family:
|
As for the `https_proxy` with the `hidden` property, we have this:
|
||||||
|
|
||||||
.. raw:: html
|
.. raw:: html
|
||||||
|
:class: output
|
||||||
|
|
||||||
manual.<i>https</i>_proxy <br/>
|
manual.<i>https</i>_proxy <br/>
|
||||||
|
|
||||||
<b>Hidden</b>: in HTTPS case if "manual.use_for_https" is set to "true" <br/>
|
<b>Hidden</b>: in HTTPS case if "manual.use_for_https" is set to "true" <br/>
|
||||||
|
|
@ -341,6 +342,12 @@ We can see that we have for the `manual.https_proxy` family:
|
||||||
<b>Identifiers</b>:
|
<b>Identifiers</b>:
|
||||||
<ul><li>HTTPS</li>
|
<ul><li>HTTPS</li>
|
||||||
|
|
||||||
|
We can see that the hidden explanation for the `manual.https_proxy` family
|
||||||
|
is the `hidden` property's description.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
Jinja with a parameter
|
Jinja with a parameter
|
||||||
---------------------------
|
---------------------------
|
||||||
|
|
||||||
|
|
@ -425,6 +432,68 @@ that is only in the case where the identifier is `HTTPS`.
|
||||||
In this Jinja code, we can understand that only the `https_proxy` dynamic family
|
In this Jinja code, we can understand that only the `https_proxy` dynamic family
|
||||||
will be hidden when the `_.use_for_https` variable is set to `true`.
|
will be hidden when the `_.use_for_https` variable is set to `true`.
|
||||||
|
|
||||||
|
FIXME
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
rougail -m firefox/ -u yaml -yf config/01/config.yml
|
||||||
|
╭────────────── Caption ───────────────╮
|
||||||
|
│ Variable Default value │
|
||||||
|
│ Modified value │
|
||||||
|
│ (⏳ Original default value) │
|
||||||
|
╰──────────────────────────────────────╯
|
||||||
|
Variables:
|
||||||
|
┣━━ 📓 Configure Proxy Access to the Internet: Manual proxy configuration ◀ loaded from the YAML
|
||||||
|
┃ file "config/01/config.yml" (⏳ No proxy)
|
||||||
|
┗━━ 📂 Manual proxy configuration
|
||||||
|
┣━━ 📂 HTTP Proxy
|
||||||
|
┃ ┣━━ 📓 HTTP address: http.proxy.net ◀ loaded from the YAML file "config/01/config.yml"
|
||||||
|
┃ ┗━━ 📓 HTTP Port: 3128 ◀ loaded from the YAML file "config/01/config.yml" (⏳ 8080)
|
||||||
|
┣━━ 📓 Also use this proxy for HTTPS: false ◀ loaded from the YAML file "config/01/config.yml"
|
||||||
|
┃ (⏳ true)
|
||||||
|
┣━━ 📂 HTTPS Proxy
|
||||||
|
┃ ┣━━ 📓 HTTPS address: https.proxy.net ◀ loaded from the YAML file "config/01/config.yml" (⏳
|
||||||
|
┃ ┃ http.proxy.net)
|
||||||
|
┃ ┗━━ 📓 HTTPS port: 3128
|
||||||
|
┗━━ 📂 SOCKS Proxy
|
||||||
|
┣━━ 📓 SOCKS address: http.proxy.net
|
||||||
|
┣━━ 📓 SOCKS port: 3128
|
||||||
|
┗━━ 📓 SOCKS host version used by proxy: v5
|
||||||
|
|
||||||
|
si on met à true, on a un warning :
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
🔔 Warning
|
||||||
|
┗━━ Manual proxy configuration
|
||||||
|
┗━━ HTTPS Proxy
|
||||||
|
┗━━ HTTPS address: 🔔 family "HTTPS Proxy" has property hidden, so cannot access to "HTTPS
|
||||||
|
address", it will be ignored when loading from the YAML file "config/01/config.yml"
|
||||||
|
|
||||||
|
╭───────────────────── Caption ─────────────────────╮
|
||||||
|
│ Variable Default value │
|
||||||
|
│ Unmodifiable variable Modified value │
|
||||||
|
│ (⏳ Original default value) │
|
||||||
|
╰───────────────────────────────────────────────────╯
|
||||||
|
Variables:
|
||||||
|
┣━━ 📓 Configure Proxy Access to the Internet: Manual proxy configuration ◀ loaded from the YAML
|
||||||
|
┃ file "config/01/config.yml" (⏳ No proxy)
|
||||||
|
┗━━ 📂 Manual proxy configuration
|
||||||
|
┣━━ 📂 HTTP Proxy
|
||||||
|
┃ ┣━━ 📓 HTTP address: http.proxy.net ◀ loaded from the YAML file "config/01/config.yml"
|
||||||
|
┃ ┗━━ 📓 HTTP Port: 3128 ◀ loaded from the YAML file "config/01/config.yml" (⏳ 8080)
|
||||||
|
┣━━ 📓 Also use this proxy for HTTPS: true ◀ loaded from the YAML file "config/01/config.yml"
|
||||||
|
┃ (⏳ true)
|
||||||
|
┣━━ 📂 HTTPS Proxy
|
||||||
|
┃ ┣━━ 📓 HTTPS address: http.proxy.net
|
||||||
|
┃ ┗━━ 📓 HTTPS port: 3128
|
||||||
|
┗━━ 📂 SOCKS Proxy
|
||||||
|
┣━━ 📓 SOCKS address: http.proxy.net
|
||||||
|
┣━━ 📓 SOCKS port: 3128
|
||||||
|
┗━━ 📓 SOCKS host version used by proxy: v5
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
.. keypoints:: Key points
|
.. keypoints:: Key points
|
||||||
|
|
||||||
**keywords**
|
**keywords**
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue