cln/doc
Matt Whitlock 968bb63739 doc: properly handle ``preformatted blocks``
Lowdown requires a blank line before all preformatted blocks, or it doesn't
recognize them. `tools/md2man.sh` contained some ad-hoc efforts at fixing up
some locations where these required blank lines are absent from the output of
`tools/fromschema.py`, but it missed some. Instead of playing Whack-a-Mole, use
a blanket sed expression to ensure that a blank line precedes _every_ opening
```.

`esc_underscores(…)` in `tools/fromschema.py` did not work correctly on strings
containing an odd number of backticks, notably the ``` delimiters surrounding
preformatted text blocks. Specifically, it was dropping the last backtick since
none of the alternatives in the regex matched it. Add a new alternative that
matches a whole preformatted block as a single unit.

`output_member(…)` in `tools/fromschema.py` was passing each line of a member's
description through `esc_underscores(…)` individually, but that breaks
preformatted text blocks that are naturally multi-line and leads to mistakenly
escaping underscores inside such blocks. Rewrite the code to make use of the
`outputs(…)` utility function that joins all the provided lines together before
passing the whole text through `esc_underscores(…)`.

Drive-by fix a couple of flubbed preformatted blocks in schemas.

[ Added shellcheck suppression for md2man.sh --RR ]
Changelog-None
2025-05-15 16:06:08 +09:30
..
beginners-guide doc: Remove mentions of 'helpme' plugin 2025-05-05 13:58:22 +09:30
contribute-to-core-lightning github: Remove prefix from docs and actions 2025-04-15 15:17:14 +09:30
developers-guide lightningd: deprecate (undocumented!) "unknown" old_state field in channel_state_changed notification. 2025-05-08 10:49:31 +09:30
getting-started doc: add poetry run to build instructions 2025-05-02 13:39:33 -07:00
miscellaneous move old misc file to another folder 2023-07-16 12:59:40 +09:30
node-operators-guide doc: Remove mentions of 'helpme' plugin 2025-05-05 13:58:22 +09:30
schemas doc: properly handle ``preformatted blocks`` 2025-05-15 16:06:08 +09:30
.gitignore doc: document the sql command. 2023-01-30 15:15:41 -06:00
CHANGELOG.md docs: Add configuration for the sphinx documentation generator 2019-02-18 02:42:29 +00:00
index.rst Separate reckless utility (1) and reckless rpc (7) documentation 2025-05-13 19:11:27 +09:30
LICENSE.md docs: Add LICENSE to the About section 2023-03-25 15:40:35 +10:30
lightning-cli.1.md doc: Add details and script check for testnet4 2025-01-13 15:45:19 -08:00
lightning-hsmtool.8.md lightning-hsmtool.8.md: Update documentation showing new method 2024-11-15 12:48:44 +10:30
lightning-reckless.1.md reckless: add update command 2025-05-14 13:02:03 +09:30
lightningd-config.5.md setconfig: put vars in separate "config.setconfig" file. 2025-02-24 19:38:37 +10:30
lightningd-rpc.7.md doc: fix typos 2024-02-11 11:27:41 +01:00
lightningd.8.md newaddr: various fixes for msggen and docs 2024-04-17 14:47:52 +02:00
Makefile Separate reckless utility (1) and reckless rpc (7) documentation 2025-05-13 19:11:27 +09:30
reckless.7.md Separate reckless utility (1) and reckless rpc (7) documentation 2025-05-13 19:11:27 +09:30
rpc-schema-draft.json doc: fix all JSON schemas to enforce no additional properties. 2024-10-30 15:39:12 +10:30
undoc-flags.list tools/check-manpage.sh: update undoc to a simple list. 2023-08-18 20:29:34 +09:30