Change configuration so that API doc is generated now by e.g. "SEEPARKINI=seewasser...
authorPhilipp Spitzer <philipp@spitzer.priv.at>
Tue, 26 Feb 2019 19:43:06 +0000 (20:43 +0100)
committerPhilipp Spitzer <philipp@spitzer.priv.at>
Tue, 26 Feb 2019 19:44:35 +0000 (20:44 +0100)
conf.py
index.rst
web/seepark_web.py

diff --git a/conf.py b/conf.py
index 47b1d786b3ce77c57622a357d348b8c837bdee10..0a169aa2718be1c61544b4acda4b912abb83609d 100644 (file)
--- a/conf.py
+++ b/conf.py
@@ -17,9 +17,9 @@
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 #
-import os
-import sys
-# sys.path.insert(0, os.path.abspath('.'))
+import os
+import sys
+sys.path.insert(0, os.path.abspath('web'))
 
 # -- General configuration ------------------------------------------------
 
@@ -30,7 +30,7 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = []
+extensions = ['sphinxcontrib.autohttp.flask']
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
index a382697c193fd0004069ee943b9c719454ae5fff..b584bccbc0018fec740870bb0bf11be6591ab2b3 100644 (file)
--- a/index.rst
+++ b/index.rst
@@ -3,20 +3,15 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to seepark's documentation!
-===================================
-
-Contents:
-
-.. toctree::
-   :maxdepth: 2
+Seepark API documentation
+=========================
 
+.. autoflask:: seepark_web:app
+   :undoc-static:
 
 
 Indices and tables
 ==================
 
-* :ref:`genindex`
-* :ref:`modindex`
 * :ref:`search`
 
index 70b0d4be6275031536a91512881e9061deb82158..41230299abbbd65ed49c2beb8aa144d307c50385 100644 (file)
@@ -358,6 +358,8 @@ def currentwater(version):
 
 @app.route('/report/<int:year>-<int:month>')
 def report(year, month):
+    """Report for given year and month
+    """
     paper_size = (29.7 / 2.54, 21. / 2.54)  # A4
 
     begin = datetime.datetime(year, month, 1)