Create docs/README.md

On-Point-RND · Mar 3, 2025 · f413f15 · f413f15
1 parent 2dbc492
commit f413f15
Showing 1 changed file with 14 additions and 0 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -0,0 +1,14 @@
+# Building docs
+
+The docs are available [here](https://on-point-rnd.github.io/EBES/).
+
+To build docs manually, run from the repo root
+```bash
+pip install -r requirements-dev.txt
+make html
+```
+If `make` is not installed, run manually:
+```bash
+sphinx-build -M html docs build
+```
+The static HTML docs will appear in the `build/html` folder.