Skip to content

Add Doxygen build instructions to docs/README.md #416

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
allnes merged 1 commit into from
May 19, 2025
Merged

Add Doxygen build instructions to docs/README.md #416

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 10 additions & 5 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,30 +22,35 @@ pip install -r requirements.txt
cmake -S . -B build -DUSE_DOCS=ON
```

5. Build the documentation:
5. Generate API documentation with Doxygen:
```bash
doxygen Doxyfile
```

6. Build the documentation:
```bash
cmake --build build -t docs_html
```

6. Update the documentation:
7. Update the documentation:
```bash
cmake --build build -t docs_gettext
# update documentation
cmake --build build -t docs_update
```

7. Re-build the documentation:
8. Re-build the documentation:
```bash
cmake --build build -t docs_html
```

8. Make local deployment of the changes:
9. Make local deployment of the changes:
```bash
cd _build/html
python3 -m http.server 8080
```

9. Open the documentation in your browser:
10. Open the documentation in your browser:
```bash
open http://localhost:8080/en
open http://localhost:8080/ru
Expand Down
Loading