diff --git a/README.md b/README.md index ead9189475db2f6607ea95536cb0ea24a43520cc..fde14c0a1221455078e7906787086d3ec264135e 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