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 0ac72d1ed68cfeaf595dff37fabf5ecd82309e6e..69dacc119ad48b0c52b4278f415cd8922bd24ba9 100644 (file)
--- 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