doc: fix GH/readthedocs rendering of manual pages.

They render the comment as if it's in the list. Signed-off-by: Rusty Russell <[email protected]>
ddustin · Sep 5, 2021 · 6d1897b · 6d1897b
1 parent 0f05238
commit 6d1897b
Show file tree

Hide file tree

Showing 161 changed files with 245 additions and 164 deletions.
diff --git a/doc/lightning-addgossip.7 b/doc/lightning-addgossip.7
diff --git a/doc/lightning-addgossip.7.md b/doc/lightning-addgossip.7.md
@@ -24,6 +24,7 @@ RETURN VALUE
 
 [comment]: # (GENERATE-FROM-SCHEMA-START)
 On success, an empty object is returned.
+
 [comment]: # (GENERATE-FROM-SCHEMA-END)
 
 AUTHOR
@@ -41,4 +42,4 @@ RESOURCES
 
 Main web site: <https://github.com/ElementsProject/lightning>
 
-[comment]: # ( SHA256STAMP:f807f98a54c194fab710f8a3393e96685fdbd0efa5e178cca54507a70a7a5c20)
+[comment]: # ( SHA256STAMP:86b47e27413141ffd6e8b79d83ac4a5cc80e5a7e6f5ba4b0df6825e744f9eea7)
diff --git a/doc/lightning-autocleaninvoice.7 b/doc/lightning-autocleaninvoice.7
diff --git a/doc/lightning-autocleaninvoice.7.md b/doc/lightning-autocleaninvoice.7.md
@@ -32,6 +32,7 @@ On success, an object is returned, containing:
 If **enabled** is *true*:
   - **expired_by** (u64): how long an invoice must be expired (seconds) before we delete it
   - **cycle_seconds** (u64): how long an invoice must be expired (seconds) before we delete it
+
 [comment]: # (GENERATE-FROM-SCHEMA-END)
 
 AUTHOR
@@ -49,4 +50,4 @@ RESOURCES
 
 Main web site: <https://github.com/ElementsProject/lightning>
 
-[comment]: # ( SHA256STAMP:b03847eff3fac04edb72f6ef86b31a2d05c077a8771845717a26f463ebed4ae7)
+[comment]: # ( SHA256STAMP:dc9caae8f7ca886630f2685ea972fb1113ffcfd5a5e46c2d212c3c4bbc4e5f44)
diff --git a/doc/lightning-check.7 b/doc/lightning-check.7
diff --git a/doc/lightning-check.7.md b/doc/lightning-check.7.md
@@ -26,6 +26,7 @@ RETURN VALUE
 [comment]: # (GENERATE-FROM-SCHEMA-START)
 On success, an object is returned, containing:
 - **command_to_check** (string): the *command_to_check* argument
+
 [comment]: # (GENERATE-FROM-SCHEMA-END)
 
 AUTHOR
@@ -39,4 +40,4 @@ RESOURCES
 
 Main web site: <https://github.com/ElementsProject/lightning>
 
-[comment]: # ( SHA256STAMP:3dd679aceebf5dca6daabc1b28a0f95c413daa9a689bf55270b38b57f0b17957)
+[comment]: # ( SHA256STAMP:47419eb2a6d8d83866773a49170f6fa6047de01435d602fa08487c59d87fb93c)
diff --git a/doc/lightning-checkmessage.7 b/doc/lightning-checkmessage.7
diff --git a/doc/lightning-checkmessage.7.md b/doc/lightning-checkmessage.7.md
@@ -32,6 +32,7 @@ If **verified** is *true*:
 
 If **verified** is *false*:
   - **pubkey** (pubkey): the *pubkey* (if any) which could have signed this; this is usually not useful!
+
 [comment]: # (GENERATE-FROM-SCHEMA-END)
 
 AUTHOR
@@ -49,4 +50,4 @@ RESOURCES
 
 Main web site: <https://github.com/ElementsProject/lightning>
 
-[comment]: # ( SHA256STAMP:7c0607f4a7d11de4c9d4cac0e56df8475c0a14e9f1ce70d7fc49322a5b184901)
+[comment]: # ( SHA256STAMP:eb1ea64cb5e8e16e8e7214f38184b60f2c30d8e7f68db1623fabda665bf1fdec)
diff --git a/doc/lightning-close.7 b/doc/lightning-close.7
diff --git a/doc/lightning-close.7.md b/doc/lightning-close.7.md
@@ -90,6 +90,7 @@ On success, an object is returned, containing:
 If **type** is "mutual" or "unilateral":
   - **tx** (hex): the raw bitcoin transaction used to close the channel (if it was open)
   - **txid** (txid): the transaction id of the *tx* field
+
 [comment]: # (GENERATE-FROM-SCHEMA-END)
 
 A unilateral close may still occur at any time if the peer did not
@@ -113,4 +114,4 @@ RESOURCES
 
 Main web site: <https://github.com/ElementsProject/lightning>
 
-[comment]: # ( SHA256STAMP:d590b312dff1e1fb4e0bf5540d04bfa4925f6cba51bef6664a642e382ec257d9)
+[comment]: # ( SHA256STAMP:db5ba99eb3393f6c55833f0bbace34b3ca504d490a25cb26c53b8790ae325981)
diff --git a/doc/lightning-connect.7 b/doc/lightning-connect.7
diff --git a/doc/lightning-connect.7.md b/doc/lightning-connect.7.md
@@ -53,6 +53,7 @@ On success, an object is returned, containing:
   If **type** is "ipv4", "ipv6", "torv2" or "torv3":
     - **address** (string): address in expected format for **type**
     - **port** (u16): port number
+
 [comment]: # (GENERATE-FROM-SCHEMA-END)
 
 ERRORS
@@ -88,4 +89,4 @@ RESOURCES
 
 Main web site: <https://github.com/ElementsProject/lightning>
 
-[comment]: # ( SHA256STAMP:973f366e2f87becdece4ba3b71f9a5156529d7c155bb8fcac0d2b6662a9e467d)
+[comment]: # ( SHA256STAMP:306d0966721f20c9a8688f33a030114a5ac095c6218eeb7fafd88fca97b9ee52)
diff --git a/doc/lightning-createinvoice.7 b/doc/lightning-createinvoice.7
diff --git a/doc/lightning-createinvoice.7.md b/doc/lightning-createinvoice.7.md
@@ -46,6 +46,7 @@ On success, an object is returned, containing:
 - **payment_preimage** (hex, optional): the proof of payment: SHA256 of this **payment_hash** (always 64 characters)
 - **local_offer_id** (hex, optional): the *id* of our offer which created this invoice (**experimental-offers** only). (always 64 characters)
 - **payer_note** (string, optional): the optional *payer_note* from invoice_request which created this invoice (**experimental-offers** only).
+
 [comment]: # (GENERATE-FROM-SCHEMA-END)
 
 On failure, an error is returned and no invoice is created. If the
@@ -73,4 +74,4 @@ RESOURCES
 
 Main web site: <https://github.com/ElementsProject/lightning>
 
-[comment]: # ( SHA256STAMP:72b3b200462e9e16c72dd5e3281d35d9ec2eded62e6a7d87e9361573c85dcc32)
+[comment]: # ( SHA256STAMP:4582bb142f91497a1bc09a10c745d5c03b5540c6c53675426a6c5c5d079420a9)
diff --git a/doc/lightning-createonion.7 b/doc/lightning-createonion.7
diff --git a/doc/lightning-createonion.7.md b/doc/lightning-createonion.7.md
@@ -97,6 +97,7 @@ On success, an object is returned, containing:
 - **onion** (hex): the onion packet (*onion_size* bytes)
 - **shared_secrets** (array of hexs): one shared secret for each node in the *hops* parameter:
   - the shared secret with this hop (always 64 characters)
+
 [comment]: # (GENERATE-FROM-SCHEMA-END)
 
 EXAMPLE
@@ -135,4 +136,4 @@ RESOURCES
 Main web site: <https://github.com/ElementsProject/lightning>
 
 [bolt04]: https://github.com/lightningnetwork/lightning-rfc/blob/master/04-onion-routing.md
-[comment]: # ( SHA256STAMP:68e54caa71beb0445389b61d8b384e40ec91e7569d4e2f2de05ed7612713ee64)
+[comment]: # ( SHA256STAMP:a00e746c41b59c6f34fb4a875cf3bf1cded7101f3e4d6d5b35f577d6aca6387f)
diff --git a/doc/lightning-datastore.7 b/doc/lightning-datastore.7
diff --git a/doc/lightning-datastore.7.md b/doc/lightning-datastore.7.md
@@ -39,6 +39,7 @@ On success, an object is returned, containing:
 - **generation** (u64, optional): The number of times this has been updated
 - **hex** (hex, optional): The hex data which has been added to the datastore
 - **string** (string, optional): The data as a string, if it's valid utf-8
+
 [comment]: # (GENERATE-FROM-SCHEMA-END)
 
 The following error codes may occur:
@@ -64,4 +65,4 @@ RESOURCES
 
 Main web site: <https://github.com/ElementsProject/lightning>
 
-[comment]: # ( SHA256STAMP:a66ad377a86e479704a3f5db06cffbd54bcd34fc9d36724649ace7b1f1e16bce)
+[comment]: # ( SHA256STAMP:fd53ebaf7190249460f62aa509010207dbdbc3ae3c90279f49d3c61d4a621c7d)
diff --git a/doc/lightning-decode.7 b/doc/lightning-decode.7
diff --git a/doc/lightning-decode.7.md b/doc/lightning-decode.7.md
@@ -159,6 +159,7 @@ If **type** is "bolt11 invoice", and **valid** is *true*:
   - **extra** (array of objects, optional): Any extra fields we didn't know how to parse:
     - **tag** (string): The bech32 letter which identifies this field (always 1 characters)
     - **data** (string): The bech32 data for this field
+
 [comment]: # (GENERATE-FROM-SCHEMA-END)
 
 AUTHOR
@@ -181,4 +182,4 @@ RESOURCES
 
 Main web site: <https://github.com/ElementsProject/lightning>
 
-[comment]: # ( SHA256STAMP:fbbfc116c23489d4f346b4d5eb06dd922592c543ec68e5a76b6822b2658bd46d)
+[comment]: # ( SHA256STAMP:d9e00b0a8c93fecd75aab0688204601a7ceeca0f424012cf0d04ce24b6017aee)
diff --git a/doc/lightning-decodepay.7 b/doc/lightning-decodepay.7
diff --git a/doc/lightning-decodepay.7.md b/doc/lightning-decodepay.7.md
@@ -43,6 +43,7 @@ On success, an object is returned, containing:
 - **extra** (array of objects, optional): Any extra fields we didn't know how to parse:
   - **tag** (string): The bech32 letter which identifies this field (always 1 characters)
   - **data** (string): The bech32 data for this field
+
 [comment]: # (GENERATE-FROM-SCHEMA-END)
 
 Technically, the *description* field is optional if a
@@ -68,4 +69,4 @@ RESOURCES
 
 Main web site: <https://github.com/ElementsProject/lightning>
 
-[comment]: # ( SHA256STAMP:435b2a155971979a75be7e9aefc5a686795c3ab210b94af72cf069bd5f3bcefc)
+[comment]: # ( SHA256STAMP:b6cf489b74ca9719c8adc7d17115f8109d61e288e77f8b3bed02ac64d7ede08f)
diff --git a/doc/lightning-deldatastore.7 b/doc/lightning-deldatastore.7
diff --git a/doc/lightning-deldatastore.7.md b/doc/lightning-deldatastore.7.md
@@ -25,6 +25,7 @@ On success, an object is returned, containing:
 - **generation** (u64, optional): The number of times this has been updated
 - **hex** (hex, optional): The hex data which has removed from the datastore
 - **string** (string, optional): The data as a string, if it's valid utf-8
+
 [comment]: # (GENERATE-FROM-SCHEMA-END)
 
 The following error codes may occur:
@@ -47,4 +48,4 @@ RESOURCES
 
 Main web site: <https://github.com/ElementsProject/lightning>
 
-[comment]: # ( SHA256STAMP:cd6f944965165b0e276da493592f9decb15046150367e06ff3e5b5547517d4b9)
+[comment]: # ( SHA256STAMP:b9d59e2d14e91b9440f75fc1577e9f26848821d87d8281e5ca2393adf412fa0d)
diff --git a/doc/lightning-delexpiredinvoice.7 b/doc/lightning-delexpiredinvoice.7
diff --git a/doc/lightning-delexpiredinvoice.7.md b/doc/lightning-delexpiredinvoice.7.md
@@ -20,6 +20,7 @@ RETURN VALUE
 
 [comment]: # (GENERATE-FROM-SCHEMA-START)
 On success, an empty object is returned.
+
 [comment]: # (GENERATE-FROM-SCHEMA-END)
 
 AUTHOR
@@ -37,4 +38,4 @@ RESOURCES
 
 Main web site: <https://github.com/ElementsProject/lightning>
 
-[comment]: # ( SHA256STAMP:644749218693cab4f48f6557a908aba66ae32f6b769576345f66ad62a6c7e7e0)
+[comment]: # ( SHA256STAMP:cfc042477a22946d8f3a07fbecf543a0063a73b54f955b1fc6adc4e8a294ec32)
diff --git a/doc/lightning-delinvoice.7 b/doc/lightning-delinvoice.7
diff --git a/doc/lightning-delinvoice.7.md b/doc/lightning-delinvoice.7.md
@@ -40,6 +40,7 @@ If **status** is "paid":
   - **amount_received_msat** (msat): how much was actually received
   - **paid_at** (u64): UNIX timestamp of when payment was received
   - **payment_preimage** (hex): SHA256 of this is the *payment_hash* offered in the invoice (always 64 characters)
+
 [comment]: # (GENERATE-FROM-SCHEMA-END)
 
 ERRORS
@@ -72,4 +73,4 @@ RESOURCES
 
 Main web site: <https://github.com/ElementsProject/lightning>
 
-[comment]: # ( SHA256STAMP:65c14a16b939461a06d81b0ff41e976ea4c7bf963cccdeba47739fe9ca1658a1)
+[comment]: # ( SHA256STAMP:63d72da38a7b758ef7fb7f3a35fbb1c48fd3f3c2a5bffef6559fc98dccd77cf6)
diff --git a/doc/lightning-delpay.7 b/doc/lightning-delpay.7
diff --git a/doc/lightning-delpay.7.md b/doc/lightning-delpay.7.md
@@ -50,6 +50,7 @@ On success, an object containing **payments** is returned.  It is an array of ob
 - **bolt11** (string, optional): the bolt11 string (if pay supplied one)
 - **bolt12** (string, optional): the bolt12 string (if supplied for pay: **experimental-offers** only).
 - **erroronion** (hex, optional): the error onion returned on failure, if any.
+
 [comment]: # (GENERATE-FROM-SCHEMA-END)
 
 On failure, an error is returned. If the lightning process fails before responding, the
@@ -99,4 +100,4 @@ RESOURCES
 ---------
 
 Main web site: <https://github.com/ElementsProject/lightning>
-[comment]: # ( SHA256STAMP:c3a603b1e43a370ff38a3d9eebe63f8acf26447b024cf5e4bd6f93fe41632529)
+[comment]: # ( SHA256STAMP:59b05702a120f92395c71c392d934ccfba343f5ffa98cfc715c657d312d457c2)
diff --git a/doc/lightning-disableoffer.7 b/doc/lightning-disableoffer.7
diff --git a/doc/lightning-disableoffer.7.md b/doc/lightning-disableoffer.7.md
@@ -43,6 +43,7 @@ On success, an object is returned, containing:
 - **bolt12_unsigned** (string): The bolt12 string representing this offer, without signature
 - **used** (boolean): Whether the offer has had an invoice paid / payment made
 - **label** (string, optional): The label provided when offer was created
+
 [comment]: # (GENERATE-FROM-SCHEMA-END)
 
 EXAMPLE JSON RESPONSE
@@ -73,4 +74,4 @@ RESOURCES
 ---------
 
 Main web site: <https://github.com/ElementsProject/lightning>
-[comment]: # ( SHA256STAMP:8f0595c22a7684d99da3000cc19b2465991fa1d2ee435a395b7a1527330aa490)
+[comment]: # ( SHA256STAMP:75f31b4614cfb2083d7f5c5de17d0892aae8504434da600132668b326fa4e0a4)
diff --git a/doc/lightning-disconnect.7 b/doc/lightning-disconnect.7
diff --git a/doc/lightning-disconnect.7.md b/doc/lightning-disconnect.7.md
@@ -35,6 +35,7 @@ RETURN VALUE
 
 [comment]: # (GENERATE-FROM-SCHEMA-START)
 On success, an empty object is returned.
+
 [comment]: # (GENERATE-FROM-SCHEMA-END)
 
 On error the returned object will contain `code` and `message` properties,
@@ -58,4 +59,4 @@ RESOURCES
 
 Main web site: <https://github.com/ElementsProject/lightning>
 
-[comment]: # ( SHA256STAMP:f807f98a54c194fab710f8a3393e96685fdbd0efa5e178cca54507a70a7a5c20)
+[comment]: # ( SHA256STAMP:86b47e27413141ffd6e8b79d83ac4a5cc80e5a7e6f5ba4b0df6825e744f9eea7)
diff --git a/doc/lightning-feerates.7 b/doc/lightning-feerates.7
diff --git a/doc/lightning-feerates.7.md b/doc/lightning-feerates.7.md
@@ -73,6 +73,7 @@ On success, an object is returned, containing:
 
 The following warnings may also be returned:
 - **warning_missing_feerates**: Some fee estimates are missing
+
 [comment]: # (GENERATE-FROM-SCHEMA-END)
 
 ERRORS
@@ -118,4 +119,4 @@ RESOURCES
 
 Main web site: <https://github.com/ElementsProject/lightning>
 
-[comment]: # ( SHA256STAMP:b7efbc2380ce39e1d8f244a9c16203f034d53b84f8396f4c4fc06973d24cefe4)
+[comment]: # ( SHA256STAMP:aa3360c535d2f7e42adead8e78a290a21c5bd88d412f9afa53dfe7388c7edeab)
diff --git a/doc/lightning-fetchinvoice.7 b/doc/lightning-fetchinvoice.7
diff --git a/doc/lightning-fetchinvoice.7.md b/doc/lightning-fetchinvoice.7.md
@@ -63,6 +63,7 @@ On success, an object is returned, containing:
   - **endtime** (u64): UNIX timestamp that the next period ends
   - **paywindow_start** (u64): UNIX timestamp of the earliest time that the next invoice can be fetched
   - **paywindow_end** (u64): UNIX timestamp of the latest time that the next invoice can be fetched
+
 [comment]: # (GENERATE-FROM-SCHEMA-END)
 
 The following error codes may occur:
@@ -87,4 +88,4 @@ RESOURCES
 
 Main web site: <https://github.com/ElementsProject/lightning>
 
-[comment]: # ( SHA256STAMP:c98a6dd644a23fb336aa2ce190e15ae602da8b4142afbed28e4243114f679e90)
+[comment]: # ( SHA256STAMP:5820acc18bb293035f040e2079363cd2ae03fd31be0c4de78b957502fbd31b4e)