Skip to content

Commit d03496b

Browse files
authored
Add Doxygen build instructions to docs/README.md (#416)
1 parent 08aa7d0 commit d03496b

File tree

1 file changed

+10
-5
lines changed

1 file changed

+10
-5
lines changed

docs/README.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,30 +22,35 @@ pip install -r requirements.txt
2222
cmake -S . -B build -DUSE_DOCS=ON
2323
```
2424

25-
5. Build the documentation:
25+
5. Generate API documentation with Doxygen:
26+
```bash
27+
doxygen Doxyfile
28+
```
29+
30+
6. Build the documentation:
2631
```bash
2732
cmake --build build -t docs_html
2833
```
2934

30-
6. Update the documentation:
35+
7. Update the documentation:
3136
```bash
3237
cmake --build build -t docs_gettext
3338
# update documentation
3439
cmake --build build -t docs_update
3540
```
3641

37-
7. Re-build the documentation:
42+
8. Re-build the documentation:
3843
```bash
3944
cmake --build build -t docs_html
4045
```
4146

42-
8. Make local deployment of the changes:
47+
9. Make local deployment of the changes:
4348
```bash
4449
cd _build/html
4550
python3 -m http.server 8080
4651
```
4752

48-
9. Open the documentation in your browser:
53+
10. Open the documentation in your browser:
4954
```bash
5055
open http://localhost:8080/en
5156
open http://localhost:8080/ru

0 commit comments

Comments
 (0)