From 9be3c6469dd808fcfe968bb63331ff21da652980 Mon Sep 17 00:00:00 2001 From: Arseniy Obolenskiy Date: Mon, 19 May 2025 16:54:10 +0200 Subject: [PATCH] Add Doxygen build instructions to docs/README.md --- docs/README.md | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/docs/README.md b/docs/README.md index f5173e08b..24de25ee6 100644 --- a/docs/README.md +++ b/docs/README.md @@ -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