From 91b3bc2b9c572d9244e1cf542655c1b32e87aaf7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?L=C5=91rinc?= Date: Thu, 22 Aug 2024 13:54:30 +0200 Subject: [PATCH] doc: Update documentation generation example in developer-notes.md To correspond to the documentation style of e.g. src/test/README.md Co-authored-by: pablomartin4btc --- doc/developer-notes.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/doc/developer-notes.md b/doc/developer-notes.md index 99c263bed5..18d6fc0619 100644 --- a/doc/developer-notes.md +++ b/doc/developer-notes.md @@ -338,9 +338,10 @@ Recommendations: ### Generating Documentation -The documentation can be generated with `cmake --build --target docs`. -The resulting files are located in `/doc/doxygen/html`; open -`index.html` in that directory to view the homepage. +Assuming the build directory is named `build`, +the documentation can be generated with `cmake --build build --target docs`. +The resulting files will be located in `build/doc/doxygen/html`; +open `index.html` in that directory to view the homepage. Before building the `docs` target, you'll need to install these dependencies: