Closed eteq closed 9 years ago
You are very right. I'll get on generating some documentation ASAP. Thanks for pointing out the astropy templates.
Cool - feel free to ping me or Adrian, either on github or in-person (at least until the end of the conference)
I've created some barebones documentation for now, which should help people get up and running. More detailed documentation, including 'advanced' features, is coming soon.
@bfarr - what about API docs? That's more what I was thinking when linking the affiliated package template - the automodapi
sphinx extension typically "just works" if you have docstrings that are valid ReST. (Note that you can use that stuff independently of astropy or the affiliated package template by just using the astropy_helpers
package, which is independent of astropy
itself).
Sorry, I lost the links in index.rst
to the API docs somewhere along the way. It should be there now.
Thanks for pointing that out!
Gotcha, cool!
Having thrown kombine to the wolves by presenting it's impressive capabilities at the #LGAstat conference, it would be fantastic if kombine had some (sphinx?) documentation describing basic use, background, and API. (Perhaps the astropy affiliated package template can be of use here?)
cc @bfarr @adrn