doc: sphinx-build fix external links (urls), language warning and broken footnote

2025-02-20 13:54:36 +01:00 · 2022-12-09 09:09:07 +02:00 · 2022-12-09 09:09:07 +02:00 · 93c966c649
commit 93c966c649
parent 3c8ec25a6f
29 changed files with 46 additions and 41 deletions
--- a/doc/FUZZING.md
+++ b/doc/FUZZING.md
@ -65,5 +65,7 @@ In order to write a new target:
     repeatedly with mutated data.
 - read about [what makes a good fuzz target](https://github.com/google/fuzzing/blob/master/docs/good-fuzz-target.md).

-A simple example is [`fuzz-addr`](tests/fuzz/fuzz-addr.c). It setups the chainparams and
+A simple example is [`fuzz-addr`][tests/fuzz/fuzz-addr.c]. It setups the chainparams and
 context (wally, tmpctx, ..) in `init()` then bruteforces the bech32 encoder in `run()`.
+
+[tests/fuzz/fuzz-addr.c]: https://github.com/ElementsProject/lightning/blob/master/tests/fuzz/fuzz-addr.c
--- a/doc/PLUGINS.md
+++ b/doc/PLUGINS.md
@ -7,7 +7,9 @@ variety of ways:

 - **Command line option passthrough** allows plugins to register their
   own command line options that are exposed through `lightningd` so
-   that only the main process needs to be configured[^options].
+   that only the main process needs to be configured. Option values are not
+   remembered when a plugin is stopped or killed, but can be passed as parameters
+   to [`plugin start`][lightning-plugin].
 - **JSON-RPC command passthrough** adds a way for plugins to add their
   own commands to the JSON-RPC interface.
 - **Event stream subscriptions** provide plugins with a push-based
@ -23,13 +25,10 @@ server and `lightningd` acting as client. The plugin file needs to be
 executable (e.g. use `chmod a+x plugin_name`)

 A `helloworld.py` example plugin based on [pyln-client][pyln-client]
-can be found [here](../contrib/plugins/helloworld.py). There is also a
-[repository](https://github.com/lightningd/plugins) with a collection of
+can be found [here][contrib/plugins].
+There is also a [repository](https://github.com/lightningd/plugins) with a collection of
 actively maintained plugins and finally, `lightningd`'s own internal
-[tests](../tests) can be a useful (and most reliable) resource.
-
-[^options]:  Only for plugins that start when `lightningd` starts, option
-    values are not remembered when a plugin is stopped or killed.
+[tests][tests] can be a useful (and most reliable) resource.

 ### Warning

@ -160,7 +159,7 @@ you plan on removing them: this will disable them if the user sets
 right?).

 The `nonnumericids` indicates that the plugin can handle
-string JSON request `id` fields: prior to v22.11 lightningd used numbers 
+string JSON request `id` fields: prior to v22.11 lightningd used numbers
 for these, and the change to strings broke some plugins.  If not set,
 then strings will be used once this feature is removed after v23.05.
 See [the lightning-rpc documentation][lightning-rpc.7.md] for how to handle
@ -1783,10 +1782,12 @@ The plugin must broadcast it and respond with the following fields:
 [bolt4-failure-messages]: https://github.com/lightning/bolts/blob/master/04-onion-routing.md#failure-messages
 [bolt4-failure-onion]: https://github.com/lightning/bolts/blob/master/04-onion-routing.md#returning-errors
 [bolt2-open-channel]: https://github.com/lightning/bolts/blob/master/02-peer-protocol.md#the-open_channel-message
-[sendcustommsg]: lightning-sendcustommsg.7.html
+[sendcustommsg]: lightning-sendcustommsg.7.md
 [oddok]: https://github.com/lightning/bolts/blob/master/00-introduction.md#its-ok-to-be-odd
-[spec]: [https://github.com/lightning/bolts]
+[spec]: https://github.com/lightning/bolts
 [bolt9]: https://github.com/lightning/bolts/blob/master/09-features.md
 [lightning-plugin]: lightning-plugin.7.md
-[pyln-client]: ../contrib/pyln-client
-[lightning-rpc.7.md]: lightning-rpc.7.md
+[pyln-client]: https://github.com/ElementsProject/lightning/tree/master/contrib/pyln-client
+[contrib/plugins]: https://github.com/ElementsProject/lightning/tree/master/contrib/plugins
+[tests]: https://github.com/ElementsProject/lightning/tree/master/tests
+[lightning-rpc.7.md]: lightningd-rpc.7.md
--- a/doc/TOR.md
+++ b/doc/TOR.md
@ -281,7 +281,7 @@ to add *two* lines in your lightningd config file:

 1. A local address which lightningd can tell Tor to connect to when
   connections come in, e.g. `bind-addr=127.0.0.1:9735`.
-2. After that, a `addr=statictor:127.0.0.1:9051` to tell 
+2. After that, a `addr=statictor:127.0.0.1:9051` to tell
   Core Lightning to set up and announce a Tor onion address (and tell
   Tor to send connections to our real address, above).

--- a/doc/conf.py
+++ b/doc/conf.py
@ -76,7 +76,7 @@ release = version
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = 'en'

 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:
--- a/doc/lightning-batching.7.md
+++ b/doc/lightning-batching.7.md
@ -53,4 +53,4 @@ RESOURCES

 Main web site: <https://github.com/ElementsProject/lightning>

-[comment]: # ( SHA256STAMP:326e5801f65998e13e909d8b682e9fbc9824f3a43aa7da1d76b871882e52f293)
+[comment]: # ( SHA256STAMP:6ab8038cbad395e5a65a52fe66948740ad360c123e42c28d5879f5f03369b744)
--- a/doc/lightning-decode.7.md
+++ b/doc/lightning-decode.7.md
@ -292,9 +292,9 @@ SEE ALSO

 lightning-pay(7), lightning-offer(7), lightning-offerout(7), lightning-fetchinvoice(7), lightning-sendinvoice(7), lightning-commando-rune(7)

-[BOLT #11](https://github.com/lightningnetwork/bolts/blob/master/11-payment-encoding.md).
+[BOLT #11](https://github.com/lightning/bolts/blob/master/11-payment-encoding.md)

-[BOLT #12](https://github.com/rustyrussell/lightning-rfc/blob/guilt/offers/12-offer-encoding.md).
+[BOLT #12](https://github.com/rustyrussell/lightning-rfc/blob/guilt/offers/12-offer-encoding.md) (experimental, [bolt](https://github.com/lightning/bolts) #798)


 RESOURCES
--- a/doc/lightning-delpay.7.md
+++ b/doc/lightning-delpay.7.md
@ -107,4 +107,4 @@ RESOURCES

 Main web site: <https://github.com/ElementsProject/lightning>

-[comment]: # ( SHA256STAMP:1ce2241eeae759ed5566342fb7810e62fa2c618f2465314f17376ebe9b6d24f8)
+[comment]: # ( SHA256STAMP:6f1e5f66278e49d10d5556abfabbab6a178f0dbd518b669ce93a32e6763dd458)
--- a/doc/lightning-disableoffer.7.md
+++ b/doc/lightning-disableoffer.7.md
@ -75,4 +75,4 @@ RESOURCES

 Main web site: <https://github.com/ElementsProject/lightning>

-[comment]: # ( SHA256STAMP:b471374a7c160373b328c2171953225b7fa27d26314a270e95320c1b6ef57307)
+[comment]: # ( SHA256STAMP:f6896438745837d5f1f5999553b397660eded7b22e5d0765ce5feaa3fc14e48e)
--- a/doc/lightning-getinfo.7.md
+++ b/doc/lightning-getinfo.7.md
@ -132,4 +132,4 @@ RESOURCES

 Main web site: <https://github.com/ElementsProject/lightning>

-[comment]: # ( SHA256STAMP:0e54af449933b833f2e74bab9fde46096a79d69b4d958a548c7c0b7cc5654e99)
+[comment]: # ( SHA256STAMP:ce2b96e2e97cf6bc1e311d6125253dfbed900f13c001f518e9a0b4f202a0e1d6)
--- a/doc/lightning-getlog.7.md
+++ b/doc/lightning-getlog.7.md
@ -95,4 +95,4 @@ RESOURCES

 Main web site: <https://github.com/ElementsProject/lightning>

-[comment]: # ( SHA256STAMP:0f6e346c57e59aa8ebe0aee9bcb7ded6f66776752e55c4c125f4a80d98cf90fd)
+[comment]: # ( SHA256STAMP:6b925456a06076ba98a04df3ff6931d2cd5d09ccec82829301428493ff824e34)
--- a/doc/lightning-help.7.md
+++ b/doc/lightning-help.7.md
@ -69,4 +69,4 @@ RESOURCES

 Main web site: <https://github.com/ElementsProject/lightning>

-[comment]: # ( SHA256STAMP:48f9ef4d1d73aa13ebd1ffa37107111c35c1a197bbcf00f52c5149847ca57ac1)
+[comment]: # ( SHA256STAMP:64c5aa03469d6cb3e00e46141a5f11e499a0cc74a13b5600b26aa6dd1539346f)
--- a/doc/lightning-listconfigs.7.md
+++ b/doc/lightning-listconfigs.7.md
@ -220,4 +220,4 @@ RESOURCES

 Main web site: <https://github.com/ElementsProject/lightning>

-[comment]: # ( SHA256STAMP:745268f7f4e4eb19d04ec1a221fbb734d89b4a266049cde3adc3131d86423294)
+[comment]: # ( SHA256STAMP:862a1d319a30cb4a0e851d0d57b62eef78d7b7e35f76c70c6bc71d4d2f270a94)
--- a/doc/lightning-listnodes.7.md
+++ b/doc/lightning-listnodes.7.md
@ -100,4 +100,4 @@ RESOURCES

 Main web site: <https://github.com/ElementsProject/lightning>

-[comment]: # ( SHA256STAMP:7f1378c1376ade1c9912c8eef3ebc77b13cbc5194ee813f8f1b4e0061338e0bb)
+[comment]: # ( SHA256STAMP:030d48d2a5fc02cb26fc2a35125116085eb67d0afc39066259adacc433a3d38b)
--- a/doc/lightning-listoffers.7.md
+++ b/doc/lightning-listoffers.7.md
@ -81,4 +81,4 @@ RESOURCES

 Main web site: <https://github.com/ElementsProject/lightning>

-[comment]: # ( SHA256STAMP:985a6bae4b0a1702cd02998859c8072eee44b219c15294af4f4078465531c8c9)
+[comment]: # ( SHA256STAMP:088d6fef8790bc9151b07f9b974568ce612c7fea8f52fdcaaf52b32e4ef8d5f2)
--- a/doc/lightning-listtransactions.7.md
+++ b/doc/lightning-listtransactions.7.md
@ -106,4 +106,4 @@ RESOURCES

 Main web site: <https://github.com/ElementsProject/lightning>

-[comment]: # ( SHA256STAMP:f7c39908eaa1a2561597c8f97658b873953daab0a68ed2e9b68e434a55d55efe)
+[comment]: # ( SHA256STAMP:1a1afbcbcdbd19df28020d48c581dfff6ed4f5beaf557e1423edb6828eb78a07)
--- a/doc/lightning-multifundchannel.7.md
+++ b/doc/lightning-multifundchannel.7.md
@ -164,4 +164,4 @@ RESOURCES

 Main web site: <https://github.com/ElementsProject/lightning>

-[comment]: # ( SHA256STAMP:a507d57bbf36455924497c8354f41e225bc16f63f12fe01b4f7c4af37f0c6960)
+[comment]: # ( SHA256STAMP:0dc2b563ed6995f65388a52b01e8882a167ead3c1d3b3dc985486cd8b4dfe157)
--- a/doc/lightning-multiwithdraw.7.md
+++ b/doc/lightning-multiwithdraw.7.md
@ -73,4 +73,4 @@ RESOURCES

 Main web site: <https://github.com/ElementsProject/lightning>

-[comment]: # ( SHA256STAMP:6c0054088c17481dedbedb6a5ed4be7f09ce8783780707432907508ebf4bbd7a)
+[comment]: # ( SHA256STAMP:632868a585b9150a80ccc4ba173d90a8beebab8e604c06f1ccdc4493604152e3)
--- a/doc/lightning-notifications.7.md
+++ b/doc/lightning-notifications.7.md
@ -103,4 +103,4 @@ RESOURCES

 Main web site: <https://github.com/ElementsProject/lightning>

-[comment]: # ( SHA256STAMP:326e5801f65998e13e909d8b682e9fbc9824f3a43aa7da1d76b871882e52f293)
+[comment]: # ( SHA256STAMP:6ab8038cbad395e5a65a52fe66948740ad360c123e42c28d5879f5f03369b744)
--- a/doc/lightning-openchannel_abort.7.md
+++ b/doc/lightning-openchannel_abort.7.md
@ -56,4 +56,4 @@ RESOURCES

 Main web site: <https://github.com/ElementsProject/lightning>

-[comment]: # ( SHA256STAMP:ed449af5b443c981faaff360cb2276816bbc7cd80f85fdb4403987c29d65baed)
+[comment]: # ( SHA256STAMP:f80423882383e5cb39b86543eb8cfbc0d9b6731ea85af3b3e1fb8973b9355781)
--- a/doc/lightning-openchannel_bump.7.md
+++ b/doc/lightning-openchannel_bump.7.md
@ -82,4 +82,4 @@ RESOURCES

 Main web site: <https://github.com/ElementsProject/lightning>

-[comment]: # ( SHA256STAMP:3cba5d1c16925322754eae979e956132e8b94e40da0dee6925037a8854d9b791)
+[comment]: # ( SHA256STAMP:fe2bf77f2cb693ee91ab1977d05ba8431b0a8bed67aa1bbda6992bf64604081b)
--- a/doc/lightning-openchannel_init.7.md
+++ b/doc/lightning-openchannel_init.7.md
@ -104,4 +104,4 @@ RESOURCES

 Main web site: <https://github.com/ElementsProject/lightning>

-[comment]: # ( SHA256STAMP:18421f03dece31aafe32cb1a9b520dd6b898e018cb187de6d666e391232fab4e)
+[comment]: # ( SHA256STAMP:ca7708f0c64afc898cb336eafb26ee384895f83b2026aecab75596372d33e46e)
--- a/doc/lightning-openchannel_signed.7.md
+++ b/doc/lightning-openchannel_signed.7.md
@ -68,4 +68,4 @@ RESOURCES

 Main web site: <https://github.com/ElementsProject/lightning>

-[comment]: # ( SHA256STAMP:41e2a4aed1aaac01675f99e91326197afa370a05e32b2ef20cbbb8247de57289)
+[comment]: # ( SHA256STAMP:2ee447b0f9d13ebe8898addc99f52a9024f0e80f67fa505dcc35a3256c3e4c55)
--- a/doc/lightning-openchannel_update.7.md
+++ b/doc/lightning-openchannel_update.7.md
@ -73,4 +73,4 @@ RESOURCES

 Main web site: <https://github.com/ElementsProject/lightning>

-[comment]: # ( SHA256STAMP:14632f65d4c44b34762d3fa7e0f5b823a519d3dc5fc7a2a69f677000efd937fb)
+[comment]: # ( SHA256STAMP:223ec3a444341e4c269eab3c3fbe80f13df9258b5f7a548d9e32698a5d4d6790)
--- a/doc/lightning-ping.7.md
+++ b/doc/lightning-ping.7.md
@ -71,4 +71,4 @@ RESOURCES

 Main web site: <https://github.com/ElementsProject/lightning>

-[comment]: # ( SHA256STAMP:f33aa4d93ca623ff7cd5e4062e0533f617b00372797f8ee0d2498479d2fe08a9)
+[comment]: # ( SHA256STAMP:fe8760ada0a86222a74dc1c78ff111325a2247d5ca90683347b8e8f5dee8a867)
--- a/doc/lightning-sendpsbt.7.md
+++ b/doc/lightning-sendpsbt.7.md
@ -67,4 +67,4 @@ RESOURCES

 Main web site: <https://github.com/ElementsProject/lightning>

-[comment]: # ( SHA256STAMP:6c0054088c17481dedbedb6a5ed4be7f09ce8783780707432907508ebf4bbd7a)
+[comment]: # ( SHA256STAMP:632868a585b9150a80ccc4ba173d90a8beebab8e604c06f1ccdc4493604152e3)
--- a/doc/lightning-signmessage.7.md
+++ b/doc/lightning-signmessage.7.md
@ -23,7 +23,7 @@ On success, an object is returned, containing:

 - **signature** (hex): The signature (always 128 characters)
 - **recid** (hex): The recovery id (0, 1, 2 or 3) (always 2 characters)
- **zbase** (string): *signature* and *recid* encoded in a style compatible with **lnd**'s [SignMessageRequest](https://api.lightning.community/#grpc-request-signmessagerequest)
+- **zbase** (string): *signature* and *recid* encoded in a style compatible with **lnd**'s [SignMessageRequest](https://api.lightning.community/#signmessage-2)

 [comment]: # (GENERATE-FROM-SCHEMA-END)

--- a/doc/lightning-signpsbt.7.md
+++ b/doc/lightning-signpsbt.7.md
@ -73,4 +73,4 @@ RESOURCES

 Main web site: <https://github.com/ElementsProject/lightning>

-[comment]: # ( SHA256STAMP:0daef100b12490126849fcb93a9e861554807d1a5acf68bc17de92a30505e18a)
+[comment]: # ( SHA256STAMP:655ef649bd68e29da6026cacf3d6f7399c5d9b2ac153c53e66cda9ece3fd761f)
--- a/doc/lightning-stop.7.md
+++ b/doc/lightning-stop.7.md
@ -44,4 +44,4 @@ RESOURCES

 Main web site: <https://github.com/ElementsProject/lightning>

-[comment]: # ( SHA256STAMP:2103952683449a5aa313eefa9c850dc0ae1cf4aa65edeb7897a8748a010a9349)
+[comment]: # ( SHA256STAMP:3ad64970d67b1084b6f33bb690ba1dd3744292a60b3efe8a845f88a0ebc61450)
--- a/doc/schemas/WRITING_SCHEMAS.md
+++ b/doc/schemas/WRITING_SCHEMAS.md
@ -37,7 +37,7 @@ You should always list all fields which are *always* present in
 `"required"`.

 We extend the basic types; see
-[contrib/pyln-testing/pyln/testing/fixtures.py](fixtures.py).
+[fixtures.py][contrib/pyln-testing/pyln/testing/fixtures.py].

 In addition, before committing a new schema or a new version of it, make sure that it
 is well formatted. If you don't want do it by hand, use `make fmt-schema` that uses
@ -78,3 +78,5 @@ To add conditional fields:

 Good luck!
 Rusty.
+
+[contrib/pyln-testing/pyln/testing/fixtures.py]: https://github.com/ElementsProject/lightning/tree/master/contrib/pyln-testing/pyln/testing/fixtures.py