X-Git-Url: https://git.toastfreeware.priv.at/chrisu/seepark.git/blobdiff_plain/6f44099da5302ffd31089434f87e64fe82b203d8..c7e259af5499c1cd5b15389936fec83a0cb2554c:/web/README

diff --git a/web/README b/web/README
index 0ac72d1..69dacc1 100644
--- a/web/README
+++ b/web/README
@@ -1,4 +1,4 @@
-Needed packages: (python3-flask python3-sqlalchemy) python3-mysqldb python3-flask-sqlalchemy
+Needed packages: (python3-flask python3-sqlalchemy) python3-mysqldb python3-flask-sqlalchemy python3-sphinxcontrib.httpdomain
 
 Start with:
 FLASK_APP=seepark_web.py FLASK_DEBUG=1 SEEPARKINI=~/seewasser.ini flask run
@@ -34,3 +34,23 @@ https://docs.pylonsproject.org/projects/waitress/en/latest/
 https://docs.pylonsproject.org/projects/waitress/en/latest/runner.html#runner
 
 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