From 9215c10c8b4621e165068314d9d1b719a10c516f Mon Sep 17 00:00:00 2001
From: Bryan Brancotte <bryan.brancotte@pasteur.fr>
Date: Tue, 18 Feb 2025 14:34:30 +0100
Subject: [PATCH] add README.md with sphinx-autobuild

---
 doc/README.md | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)
 create mode 100644 doc/README.md

diff --git a/doc/README.md b/doc/README.md
new file mode 100644
index 00000000..b385f56c
--- /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
+```
-- 
GitLab