diff options
| author | Lőrinc <pap.lorinc@gmail.com> | 2024-08-22 13:54:30 +0200 |
|---|---|---|
| committer | Lőrinc <pap.lorinc@gmail.com> | 2024-08-29 15:22:45 +0200 |
| commit | 91b3bc2b9c572d9244e1cf542655c1b32e87aaf7 (patch) | |
| tree | e4fdd99649114e1b7bdc96474cb73a1516c63337 | |
| parent | d08bedd81f184808c274f3c49cf5d581ccc78468 (diff) | |
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 <pablomartin4btc@gmail.com>
| -rw-r--r-- | doc/developer-notes.md | 7 |
1 files 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 <build_dir> --target docs`. -The resulting files are located in `<build_dir>/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: |