Describe how to setup a virtualenv to generate the sphinx documentation.

[chrisu/seepark.git] / web / README

diff --git a/web/README b/web/README
index 6a6ee1f6e60a4c745a7f1dceeee48b96f61f19d9..69dacc119ad48b0c52b4278f415cd8922bd24ba9 100644 (file)
--- a/web/README
+++ b/web/README
@@ -40,3 +40,17 @@ https://gr33ndata.blogspot.com/2012/01/waitress-flask.html
 Generate documentation:
 cd doc
 SEEPARKINI=~/seewasser.ini make web
+
+To make this run on Debian Buster we had to do the following first
+
+$ cd /home/philipp/opt/pyenv
+$ virtualenv -p python3 --system-site-packages seepark
+$ source seepark/bin/activate
+$ pip install --upgrade sphinx
+$ pip install --upgrade sphinxcontrib-httpdomain
+
+
+---
+
+Execute unittests
+SEEPARKINI=~/seewasser.ini python3 -m unittest seepark_web_tests.py