search

megbedell / wobble

precise data-driven RV fitting, now with tellurics!
https://wobble.readthedocs.io
MIT License
39 stars 16 forks source link

needs documentation #32

Closed megbedell closed 5 years ago

megbedell commented 5 years ago

the docstrings are mostly there so we can run sphinx. at the very least we need an informative README!

davidwhogg commented 5 years ago

Yes, and (perhaps as another issue) we need a hello-world few-line example, with data.

megbedell commented 5 years ago

I got sphinx running and set wobble up with ReadTheDocs: https://wobble.readthedocs.io/en/latest/

However, the autodocs don't seem to be working with RTD, although they do work when I build locally on my laptop. Maybe @rodluger or @dfm can help me debug?

Either way, still to do are:

megbedell commented 5 years ago

ok the docs aren't perfect but there's something there! I'm calling it done for now, will revisit if & when we make an actual public-facing tool.