diff --git a/doc/README.md b/doc/README.md new file mode 100644 index 0000000000000000000000000000000000000000..b385f56c210a7f54525a40b8bca2f3a55c018d31 --- /dev/null +++ b/doc/README.md @@ -0,0 +1,18 @@ +# https://hub.pages.pasteur.fr/strass/index.html + +# How to work in it + +Quick setup +```sh +cd docs +virtualenv .venv -p python3 +source .venv/bin/activate +pip install -r requirements.txt +``` + +And then you are able to host the doc locally to directly see your changes (at each save). +To do so, use: + +```sh +sphinx-autobuild . build/html --port 8044 +```