From 458195c29faa0330b603fd3a0cd9cbf273902108 Mon Sep 17 00:00:00 2001 From: Christian Decker Date: Wed, 7 Dec 2022 16:46:48 +0100 Subject: [PATCH] docs: Fix a number of broken links in the generated docs Changelog-None --- doc/FUZZING.md | 7 ++++--- doc/PLUGINS.md | 3 +++ doc/schemas/WRITING_SCHEMAS.md | 5 +++-- mkdocs.yml | 5 ----- 4 files changed, 10 insertions(+), 10 deletions(-) diff --git a/doc/FUZZING.md b/doc/FUZZING.md index 1be23dfcd..26da10984 100644 --- a/doc/FUZZING.md +++ b/doc/FUZZING.md @@ -65,7 +65,8 @@ 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 -context (wally, tmpctx, ..) in `init()` then bruteforces the bech32 encoder in `run()`. +A simple example is [`fuzz-addr`][fuzz-addr]. 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 +[fuzz-addr]: https://github.com/ElementsProject/lightning/blob/master/tests/fuzz/fuzz-addr.c diff --git a/doc/PLUGINS.md b/doc/PLUGINS.md index 7d71991ef..e8f7c21be 100644 --- a/doc/PLUGINS.md +++ b/doc/PLUGINS.md @@ -1794,3 +1794,6 @@ The plugin must broadcast it and respond with the following fields: [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 +[example-plugin]: https://github.com/ElementsProject/lightning/blob/master/contrib/plugins/helloworld.py +[cln-tests]: https://github.com/ElementsProject/lightning/tree/master/tests +[cln-repo]: https://github.com/lightningd/plugins diff --git a/doc/schemas/WRITING_SCHEMAS.md b/doc/schemas/WRITING_SCHEMAS.md index f4823ca4a..aff29fcef 100644 --- a/doc/schemas/WRITING_SCHEMAS.md +++ b/doc/schemas/WRITING_SCHEMAS.md @@ -45,8 +45,9 @@ are allowed by omitted from the documentation. You should always list all fields which are *always* present in `"required"`. -We extend the basic types; see -[fixtures.py][contrib/pyln-testing/pyln/testing/fixtures.py]. +We extend the basic types; see [fixtures.py][fixtures]. + +[fixtures]: https://github.com/ElementsProject/lightning/blob/master/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 diff --git a/mkdocs.yml b/mkdocs.yml index ae2e7fbed..1c323f81a 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -26,11 +26,6 @@ markdown_extensions: - pymdownx.superfences - toc: toc_depth: 2 - -python: - install: - - requirements: doc/requirements.txt - nav: - "Welcome": index.md - Users: