Documentation

[msricher]

I made a pull request ( #57 ) for a branch that adds the framework for documentation. It can render Latex equations from .RST documents in the browser.

When you try to compile the documentation, you can see that some docstrings are ill-formatted. Sphinx points them out for you.

Can we start adding our notes into either the "user" documentation as .RST files, or into the "API" documentation by improving the EOM class docstrings?

@PaulWAyers @gabrielasd

[PaulWAyers]

I can try to provide my notes in a markdown format so it is easy. I'm not very good (I suck at) RST. MyST I can do a bit (closer to markdown).

[gabrielasd]

That would be nice!
@msricher do you think we can use pandoc to convert to RST?

[gabrielasd]

Dear @msricher @PaulWAyers

I've done a bit of editing on the previous version of the notes for the EOM method in the user documentation (eom.rst) and also the docstrings of the classes.

The .rst file may be readable as it is but I can send a compiled version of it through email if it'll make things easier.
Thoughts on how it can be improved are appreciated.

note: All latest changes dealing with documentation are in the branch docs