Docs

[jlhitt1993]

I noticed our docs were not completed so I cleaned them up quite a bit. As a reminder, you can use sphinx to generate the HTML by navigating to the docs folder in your conda terminal and typing make html. Then you can open the html files in your browser to have a look.

[sbillinge]

btw @jlhitt1993 thanks so much for putting in a shift on this!

We should maybe have a meeting to plan for greater sustainability for the project.....as people graduate and other things happen in people's lives....!

[codecov-commenter]

Codecov Report

Merging #166 (5f56652) into master (8cc4364) will increase coverage by 0.70%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master     #166      +/-   ##
==========================================
+ Coverage   72.34%   73.04%   +0.70%     
==========================================
  Files           8        8              
  Lines         282      282              
==========================================
+ Hits          204      206       +2     
+ Misses         78       76       -2     

Impacted Files	Coverage Δ
tests/test_config_reader.py	78.94% <0.00%> (+10.52%)	⬆️

---

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 8cc4364...5f56652. Read the comment docs.