Skip to content

Commit 91b3bc2

Browse files
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 <[email protected]>
1 parent d08bedd commit 91b3bc2

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

doc/developer-notes.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -338,9 +338,10 @@ Recommendations:
338338

339339
### Generating Documentation
340340

341-
The documentation can be generated with `cmake --build <build_dir> --target docs`.
342-
The resulting files are located in `<build_dir>/doc/doxygen/html`; open
343-
`index.html` in that directory to view the homepage.
341+
Assuming the build directory is named `build`,
342+
the documentation can be generated with `cmake --build build --target docs`.
343+
The resulting files will be located in `build/doc/doxygen/html`;
344+
open `index.html` in that directory to view the homepage.
344345

345346
Before building the `docs` target, you'll need to install these dependencies:
346347

0 commit comments

Comments
 (0)