Add docs

[frederikgeth]

Hopefully this is a decent starting point.

[codecov[bot]]

Codecov Report

Merging #30 (58f700e) into master (e3a792b) will not change coverage. The diff coverage is n/a.

@@           Coverage Diff           @@
##           master      #30   +/-   ##
=======================================
  Coverage   92.18%   92.18%           
=======================================
  Files           9        9           
  Lines         768      768           
=======================================
  Hits          708      708           
  Misses         60       60           

---

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 e3a792b...58f700e. Read the comment docs.

[frederikgeth]

pdf generation seems to be broken. not sure what the problem is.

EDIT: pdf generation is working. If you want to test it on your local machine, you need to set up Docker.

[arpkoirala]

@frederikgeth how to set a docker? Do you have some quick links? google search landed me in a vast unknown space

[frederikgeth]

no worries, here's the install guide: https://docs.docker.com/desktop/windows/install/

I added some additional information for generating docs in docs/readme.md.

[timmyfaraday]

I'll add the IVR formulation today in the docs. Furthermore, I'll start the Pluto notebook for the five bus example, I'll do this in the same pull-request.