API

[bharding512]

A couple people have asked me questions like, "what variables are available?" "How do I get a profile of oxygen density?"

As far as I know, the only way of knowing what's available is looking at the code. We need an API. Maybe we have one and I'm just not sure where it is?

[timduly4]

Good point-- are you aware of any documentation generation software? One possibility is doxygen, but there are others.

[jswoboda]

I've started to use Sphinx and I've had some positive results. I used it to create a github page for one of my repositories which you can get from the repository readme. I modified a few scripts I found to automate the process of making the github page.

[sigvaldm]

I second this. I use Doxygen for C and C++ projects, but my experience is that for Python projects, Sphinx along with ReStructured Text (reST) and Read The Docs is the way to go. Not that it is perfect (it's a bit bloated), but it is well supported for these kinds of projects. It is also pretty nice to get the documentation online with Read The Docs. It also has a quite sane Getting Started tutorial on Read The Docs.