phantom/bitcoin
1
0
Fork 0
mirror of https://github.com/bitcoin/bitcoin.git synced 2025-04-29 14:59:39 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

doc: Update documentation generation example in developer-notes.md

Browse source 
To correspond to the documentation style of e.g. src/test/README.md

Co-authored-by: pablomartin4btc <pablomartin4btc@gmail.com>
This commit is contained in:
Lőrinc 2024-08-22 13:54:30 +02:00
parent d08bedd81f
commit 91b3bc2b9c
1 changed files with 4 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
doc/developer-notes.md
View file

@ -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: