Autodocs for datastore

[tomkooij]

Sphinx autodocs for the datastore.

This is an attempt to document the datastore (scripts, raw datastore tables) using sphinx autodoc (docstrings). I already added/enhanced some docstrings. But the datastore can use some docs. That should be fairly easy now.

Caution: The writer was a script writer in a folder writer with a main function called writer. To prevent ambiguous imports and to allow autodoc to work I change the writer into a package (analoguous to the wsgi package):

writer:
 \- __init__.py
  - writer_app.py  --> writer()
  - (modules)

So you can:

from writer import writer_app
writer_app.writer()

Perhaps writer() should be renamed application() or main()

This will require some changes in the ansible config (publicdb repo).

I changed imports in both the writer and wsgi package. But I basically reverted back to the current imports (version running on frome now), so I don't expect problems (and there are unittests), but I will rerun the acceptance tests, which are semi-automated anyway.

ToDo:

• Change to writer package in ansible/publicdb.
• Rerun acceptance tests
• Setup gh-pages
• Add to docs.hisparc.nl.
• Add documentation\docstrings

[tomkooij]

I pushed the current (7eaf413) version of the docs to http://docs.hisparc.nl/datastore/

[153957]

Added to docs.hisparc.nl: in HiSPARC/hisparc.github.io@8c72298

[153957]

Looks good to me, I think we can merge this and then improve documentation as we go. (and also merge HiSPARC/publicdb#185)

[tomkooij]

Merging. Cannot remove don't merge label on mobile...