Skip to content

Commit

Permalink
Update documentation generation example in developer-notes.md
Browse files Browse the repository at this point in the history
To correspond to the documentation style of e.g.  src/test/README.md

Co-authored-by: pablomartin4btc <pablomartin4btc@gmail.com>
  • Loading branch information
l0rinc and pablomartin4btc committed Aug 28, 2024
1 parent 0c90fc6 commit ba1913d
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions doc/developer-notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down

0 comments on commit ba1913d

Please sign in to comment.