highperfocused/bitcoin
1
0
Fork 0
mirror of https://github.com/bitcoin/bitcoin.git synced 2026-04-04 12:55:02 +02:00
Code Issues Packages Projects Releases Wiki Activity

cmake: Add docs build target

Browse Source
This commit is contained in:
Hennadii Stepanov
2024-04-23 15:44:20 +01:00
parent fb75ebbc33
commit 65bdbc1ff2
4 changed files with 30 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
doc/developer-notes.md
View File

@@ -338,11 +338,11 @@ Recommendations:
### Generating Documentation
The documentation can be generated with `make docs` and cleaned up with `make
clean-docs`. The resulting files are located in `doc/doxygen/html`; open
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.
Before running `make docs`, you'll need to install these dependencies:
Before building the `docs` target, you'll need to install these dependencies:
Linux: `sudo apt install doxygen graphviz`