Add how to create Sphinx documentation to README.
authorPhilipp Spitzer <philipp@spitzer.priv.at>
Tue, 26 Feb 2019 21:02:34 +0000 (22:02 +0100)
committerPhilipp Spitzer <philipp@spitzer.priv.at>
Tue, 26 Feb 2019 21:02:34 +0000 (22:02 +0100)
web/README

index 0ac72d1..6a6ee1f 100644 (file)
@@ -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,9 @@ 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