lxddoc: Add examples of output

Signed-off-by: Gabriel Mougard <[email protected]>
canonical · May 8, 2023 · 31bff65 · 31bff65
1 parent 08938e8
commit 31bff65
Show file tree

Hide file tree

Showing 2 changed files with 81 additions and 0 deletions.
diff --git a/.sphinx/lxddoc/lxddoc.txt b/.sphinx/lxddoc/lxddoc.txt
@@ -0,0 +1,43 @@
+---
+orphan: true
+---
+
+```{config:option} scheduler.instance cluster
+:liveupdate: `yes`
+:shortdesc: Possible values are all, manual and group. See Automatic placement of instances for more information.
+:condition: container
+:default: `all`
+:type: integer
+
+ The cluster config keys
+```
+
+```{config:option} user.* cluster
+:shortdesc: Free form user key/value storage (can be used in search).
+:condition: container
+:default: -
+:type: string
+:liveupdate: `yes`
+
+This is the real long desc.
+
+With two paragraphs.
+
+And a list:
+
+- Item
+- Item
+- Item
+
+And a table:
+
+Key                                 | Type      | Scope     | Default                                          | Description
+:--                                 | :---      | :----     | :------                                          | :----------
+`acme.agree_tos`                    | bool      | global    | `false`                                          | Agree to ACME terms of service
+`acme.ca_url`                       | string    | global    | `https://acme-v02.api.letsencrypt.org/directory` | URL to the directory resource of the ACME service
+`acme.domain`                       | string    | global    | -                                                | Domain for which the certificate is issued
+`acme.email`                        | string    | global    | -                                                | Email address used for the account registration
+
+
+```
+
diff --git a/.sphinx/lxddoc/lxddoc.yaml b/.sphinx/lxddoc/lxddoc.yaml
@@ -0,0 +1,38 @@
+configs:
+    cluster:
+        - scheduler.instance:
+            condition: container
+            default: '`all`'
+            liveupdate: '`yes`'
+            longdesc: |4-
+
+                 The cluster config keys
+            shortdesc: Possible values are all, manual and group. See Automatic placement of instances for more information.
+            type: integer
+        - user.*:
+            condition: container
+            default: '-'
+            liveupdate: '`yes`'
+            longdesc: |4+
+
+                This is the real long desc.
+
+                With two paragraphs.
+
+                And a list:
+
+                - Item
+                - Item
+                - Item
+
+                And a table:
+
+                Key                                 | Type      | Scope     | Default                                          | Description
+                :--                                 | :---      | :----     | :------                                          | :----------
+                `acme.agree_tos`                    | bool      | global    | `false`                                          | Agree to ACME terms of service
+                `acme.ca_url`                       | string    | global    | `https://acme-v02.api.letsencrypt.org/directory` | URL to the directory resource of the ACME service
+                `acme.domain`                       | string    | global    | -                                                | Domain for which the certificate is issued
+                `acme.email`                        | string    | global    | -                                                | Email address used for the account registration
+
+            shortdesc: Free form user key/value storage (can be used in search).
+            type: string