Add documentation

[dbrgn]

Argh, I only saw your docs branch once I pushed mine.

Anyways, here's documentation implemented using mkdocs, which is a bit simpler and faster than sphinx. It does not support generating API docs, but I think API docs are overrated anyways and prose is much more important.

If you like this I can set up auto builds with Travis on Readthedocs.

Refs #2

[dbrgn]

To build: Install the requirements.txt and run make.

[codecov-io]

Codecov Report

Merging #62 into master will not change coverage. The diff coverage is n/a.

@@           Coverage Diff           @@
##           master      #62   +/-   ##
=======================================
  Coverage   76.76%   76.76%           
=======================================
  Files           9        9           
  Lines        1278     1278           
  Branches      153      153           
=======================================
  Hits          981      981           
  Misses        250      250           
  Partials       47       47

---

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 9b2a2ee...48b7247. Read the comment docs.

[lgrahl]

Mh... I mean we have no real API doc so far anyway... I'll need to think about this. Would definitely like to migrate to Sphinx later (converting the Markdown files is easy).

[dbrgn]

That'll be easy, but it's better to have non-sphinx docs than to have no docs.

[dbrgn]

Updated!

[dbrgn]

Actually I'd link to the docs from the README file. There's no advantage in keeping the information in two places and always having to sync the docs and the README.

But for that I'd have to set up automated test building etc. Should I?

[lgrahl]

But for that I'd have to set up automated test building etc.

What do you mean by that?

[dbrgn]

Setting up automated builds of the docs through Readthedocs, triggered by successful tests :) Once we have always-up-to-date docs, we can link to them from the README and remove the instructions from the README.

[dbrgn]

@lgrahl still interested in this?

[lgrahl]

I think it's a good reminder that we need docs and this is a good start. Let's leave it open.