add build docs to readme

johannes-graeter · Feb 11, 2024 · 26d7946 · 26d7946
1 parent 00acae0
commit 26d7946
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -5,6 +5,7 @@ cmake-build-*/
 conan-cache/
 Testing/
 docs/_build/*
+docs/_build_doxygen/*
 
 # User spesific settings
 CMakeUserPresets.json

diff --git a/README.md b/README.md
@@ -131,6 +131,18 @@ Note that caused by a bug in libc++ (as of 2024/02/07) you must set ASAN_OPTIONS
 * Ubuntu 22.04: Clang-17
 * Ubuntu 22.04: gcc-13
 
+
+## Build docs
+We have experimental ReadTheDocs style docs to build (Doxygen >=1.9.8 is recommended and must be preinstalled)
+```bash
+pushd docs
+pip3 install -r requirements.txt
+doxygen Doxyfile.in
+make html
+popd
+```
+open `docs/_build/html/index.html` in your browser.
+
 ## More Details
 
  * [Dependency Setup](README_dependencies.md)