From ea5e9492252078de321d02f8c0c04fca75acf8aa Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Ma=C3=ABl=20Madon?= <mael.madon@irit.fr>
Date: Tue, 18 Jun 2024 12:16:39 +0200
Subject: [PATCH] doc: readme on how to build the doc

---
 README.md | 18 +++++++++++++++++-
 1 file changed, 17 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index ead9189..fde14c0 100644
--- a/README.md
+++ b/README.md
@@ -102,6 +102,22 @@ nix-shell -A test --command "pytest"
 
 For more information about the tests, read the [test README](test/README.md)
 
+## Build the documentation
+Batmen documentation is hosted on readthedocs: [Batmen doc].
+It is automatically built and updated whenever there is a push on Batmen's `master` branch.
+
+To build the doc manually, we provide a dedicated nix shell.
+From Batmen root directory:
+
+```shell
+cd docs/
+nix-shell -A doc
+make html
+```
+
+The doc is generated inside the folder `docs/_build` and can be viewed on the browser by opening the file `docs/_build/html/index.html`. 
+
 [Nix]: https://nixos.org/nix/
 [Batsim]: https://batsim.org/
-[batsched]: https://framagit.org/batsim/batsched
\ No newline at end of file
+[batsched]: https://framagit.org/batsim/batsched
+[Batmen doc]: https://batmen.readthedocs.io/en/latest/
\ No newline at end of file
-- 
GitLab