documentation

[jeremymanning]

It'd be nice to have some documentation (e.g. a readme file) with some simple examples. And maybe a Sphinx-generated API? Some ipython notebooks w/ simple example datasets would be cool too.

[andrewheusser]

definitely. We were thinking that we'd push ahead to get those EL reports to you first, and then clean up the code, fill in the documentation, add examples etc before making it public

[jeremymanning]

perfect. thanks!

[andrewheusser]

@KirstensGitHub one thing that would be super useful to work on when you have time is getting all the doc strings up to date, and create a sphinx documentation website with examples. You can model it exactly how I set it up in hypertools

[andrewheusser]

the docs are up to date at - http://cdl-quail.readthedocs.io/en/latest/

@jeremymanning do you have any edits? if not i think we can close this