docs: Use blockreplace.py to include all manpages

2025-01-18 05:12:45 +01:00 · 2022-12-19 15:43:58 +01:00 · 2022-12-19 15:43:58 +01:00 · 826c746568
commit 826c746568
parent f19792c241
2 changed files with 135 additions and 9 deletions
--- a/10
+++ b/10
@ -424,6 +424,16 @@ PKGLIBEXEC_PROGRAMS = \
 	       lightningd/lightning_openingd \
 	       lightningd/lightning_websocketd

+mkdocs.yml: $(MANPAGES:=.md)
+	@$(call VERBOSE, "genidx $@", \
+	  find doc -maxdepth 1 -name '*\.[0-9]\.md' | \
+	  cut -b 5- | LC_ALL=C sort | \
+	  sed 's/\(.*\)\.\(.*\).*\.md/- "\1": "\1.\2.md"/' | \
+	  python3 devtools/blockreplace.py mkdocs.yml manpages --language=yml --indent "          " \
+	)
+
+
+
 # Don't delete these intermediaries.
 .PRECIOUS: $(ALL_GEN_HEADERS) $(ALL_GEN_SOURCES)

--- a/mkdocs.yml
+++ b/mkdocs.yml
@ -21,32 +21,148 @@ theme:
 markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
+  - admonition
+  - pymdownx.details
  - pymdownx.inlinehilite
  - pymdownx.snippets
-  - pymdownx.superfences
+  - pymdownx.superfences:
+      custom_fences:
+        - name: mermaid
+          class: mermaid
+          format: !!python/name:pymdownx.superfences.fence_code_format
  - toc:
      toc_depth: 2
+
 nav:
  - "Welcome": index.md
  - Users:
+      - user/index.md
      - Installation: "INSTALL.md"
-      - "Frequently Asked Question": "FAQ.md"
+      - Backups: "BACKUP.md"
+      - Frequently Asked Question: "FAQ.md"
      - "TOR": "TOR.md"
  - Developers:
      - dev/index.md
      - "Developing a plugin": PLUGINS.md
      - "Contributors":
-          - dev/contributors/index.md
-          - "Writing JSON Schemas": schemas/WRITING_SCHEMAS.md
-          - Fuzzing: FUZZING.md
-          - "Reproducible Builds": REPRODUCIBLE.md
-          - "Coding Style": STYLE.md
+        - dev/contributors/index.md
+        - Hacking: HACKING.md
+        - "Coding Style": STYLE.md
+        - "Writing JSON Schemas": schemas/WRITING_SCHEMAS.md
+        - dev/contributors/codegen.md
+        - "Gossip Store Format": GOSSIP_STORE.md
+        - "Fuzzing": FUZZING.md
+      - Maintainers:
+        - "Making Releases": MAKING-RELEASES.md
+        - "Reproducible Builds": REPRODUCIBLE.md

  - Reference:
      - reference/index.md
      - "Man Pages":
-          - lightningd-rpc: lightningd-rpc.7.md
-          - "lightning-withdraw": "./lightning-withdraw.7.md"
+          # block_start manpages
+          - "lightning-addgossip": "lightning-addgossip.7.md"
+          - "lightning-autoclean-once": "lightning-autoclean-once.7.md"
+          - "lightning-autoclean-status": "lightning-autoclean-status.7.md"
+          - "lightning-batching": "lightning-batching.7.md"
+          - "lightning-bkpr-channelsapy": "lightning-bkpr-channelsapy.7.md"
+          - "lightning-bkpr-dumpincomecsv": "lightning-bkpr-dumpincomecsv.7.md"
+          - "lightning-bkpr-inspect": "lightning-bkpr-inspect.7.md"
+          - "lightning-bkpr-listaccountevents": "lightning-bkpr-listaccountevents.7.md"
+          - "lightning-bkpr-listbalances": "lightning-bkpr-listbalances.7.md"
+          - "lightning-bkpr-listincome": "lightning-bkpr-listincome.7.md"
+          - "lightning-check": "lightning-check.7.md"
+          - "lightning-checkmessage": "lightning-checkmessage.7.md"
+          - "lightning-cli": "lightning-cli.1.md"
+          - "lightning-close": "lightning-close.7.md"
+          - "lightning-commando-rune": "lightning-commando-rune.7.md"
+          - "lightning-commando": "lightning-commando.7.md"
+          - "lightning-connect": "lightning-connect.7.md"
+          - "lightning-createinvoice": "lightning-createinvoice.7.md"
+          - "lightning-createonion": "lightning-createonion.7.md"
+          - "lightning-datastore": "lightning-datastore.7.md"
+          - "lightning-decode": "lightning-decode.7.md"
+          - "lightning-decodepay": "lightning-decodepay.7.md"
+          - "lightning-deldatastore": "lightning-deldatastore.7.md"
+          - "lightning-delexpiredinvoice": "lightning-delexpiredinvoice.7.md"
+          - "lightning-delforward": "lightning-delforward.7.md"
+          - "lightning-delinvoice": "lightning-delinvoice.7.md"
+          - "lightning-delpay": "lightning-delpay.7.md"
+          - "lightning-disableoffer": "lightning-disableoffer.7.md"
+          - "lightning-disconnect": "lightning-disconnect.7.md"
+          - "lightning-emergencyrecover": "lightning-emergencyrecover.7.md"
+          - "lightning-feerates": "lightning-feerates.7.md"
+          - "lightning-fetchinvoice": "lightning-fetchinvoice.7.md"
+          - "lightning-fundchannel": "lightning-fundchannel.7.md"
+          - "lightning-fundchannel_cancel": "lightning-fundchannel_cancel.7.md"
+          - "lightning-fundchannel_complete": "lightning-fundchannel_complete.7.md"
+          - "lightning-fundchannel_start": "lightning-fundchannel_start.7.md"
+          - "lightning-funderupdate": "lightning-funderupdate.7.md"
+          - "lightning-fundpsbt": "lightning-fundpsbt.7.md"
+          - "lightning-getinfo": "lightning-getinfo.7.md"
+          - "lightning-getlog": "lightning-getlog.7.md"
+          - "lightning-getroute": "lightning-getroute.7.md"
+          - "lightning-help": "lightning-help.7.md"
+          - "lightning-hsmtool": "lightning-hsmtool.8.md"
+          - "lightning-invoice": "lightning-invoice.7.md"
+          - "lightning-keysend": "lightning-keysend.7.md"
+          - "lightning-listchannels": "lightning-listchannels.7.md"
+          - "lightning-listconfigs": "lightning-listconfigs.7.md"
+          - "lightning-listdatastore": "lightning-listdatastore.7.md"
+          - "lightning-listforwards": "lightning-listforwards.7.md"
+          - "lightning-listfunds": "lightning-listfunds.7.md"
+          - "lightning-listhtlcs": "lightning-listhtlcs.7.md"
+          - "lightning-listinvoices": "lightning-listinvoices.7.md"
+          - "lightning-listnodes": "lightning-listnodes.7.md"
+          - "lightning-listoffers": "lightning-listoffers.7.md"
+          - "lightning-listpays": "lightning-listpays.7.md"
+          - "lightning-listpeers": "lightning-listpeers.7.md"
+          - "lightning-listsendpays": "lightning-listsendpays.7.md"
+          - "lightning-listtransactions": "lightning-listtransactions.7.md"
+          - "lightning-makesecret": "lightning-makesecret.7.md"
+          - "lightning-multifundchannel": "lightning-multifundchannel.7.md"
+          - "lightning-multiwithdraw": "lightning-multiwithdraw.7.md"
+          - "lightning-newaddr": "lightning-newaddr.7.md"
+          - "lightning-notifications": "lightning-notifications.7.md"
+          - "lightning-offer": "lightning-offer.7.md"
+          - "lightning-offerout": "lightning-offerout.7.md"
+          - "lightning-openchannel_abort": "lightning-openchannel_abort.7.md"
+          - "lightning-openchannel_bump": "lightning-openchannel_bump.7.md"
+          - "lightning-openchannel_init": "lightning-openchannel_init.7.md"
+          - "lightning-openchannel_signed": "lightning-openchannel_signed.7.md"
+          - "lightning-openchannel_update": "lightning-openchannel_update.7.md"
+          - "lightning-parsefeerate": "lightning-parsefeerate.7.md"
+          - "lightning-pay": "lightning-pay.7.md"
+          - "lightning-ping": "lightning-ping.7.md"
+          - "lightning-plugin": "lightning-plugin.7.md"
+          - "lightning-recoverchannel": "lightning-recoverchannel.7.md"
+          - "lightning-reserveinputs": "lightning-reserveinputs.7.md"
+          - "lightning-sendcustommsg": "lightning-sendcustommsg.7.md"
+          - "lightning-sendinvoice": "lightning-sendinvoice.7.md"
+          - "lightning-sendonion": "lightning-sendonion.7.md"
+          - "lightning-sendonionmessage": "lightning-sendonionmessage.7.md"
+          - "lightning-sendpay": "lightning-sendpay.7.md"
+          - "lightning-sendpsbt": "lightning-sendpsbt.7.md"
+          - "lightning-setchannel": "lightning-setchannel.7.md"
+          - "lightning-setchannelfee": "lightning-setchannelfee.7.md"
+          - "lightning-signmessage": "lightning-signmessage.7.md"
+          - "lightning-signpsbt": "lightning-signpsbt.7.md"
+          - "lightning-staticbackup": "lightning-staticbackup.7.md"
+          - "lightning-stop": "lightning-stop.7.md"
+          - "lightning-txdiscard": "lightning-txdiscard.7.md"
+          - "lightning-txprepare": "lightning-txprepare.7.md"
+          - "lightning-txsend": "lightning-txsend.7.md"
+          - "lightning-unreserveinputs": "lightning-unreserveinputs.7.md"
+          - "lightning-utxopsbt": "lightning-utxopsbt.7.md"
+          - "lightning-waitanyinvoice": "lightning-waitanyinvoice.7.md"
+          - "lightning-waitblockheight": "lightning-waitblockheight.7.md"
+          - "lightning-waitinvoice": "lightning-waitinvoice.7.md"
+          - "lightning-waitsendpay": "lightning-waitsendpay.7.md"
+          - "lightning-withdraw": "lightning-withdraw.7.md"
+          - "lightningd-config": "lightningd-config.5.md"
+          - "lightningd-rpc": "lightningd-rpc.7.md"
+          - "lightningd": "lightningd.8.md"
+          - "reckless": "reckless.7.md"
+          # block_end manpages
  - About:
      - Changelog: "CHANGELOG.md"
      - License: "LICENSE.md"