Add Sphinx automod API docs #83
Conversation
| header : `~astropy.io.fits.Header` | ||
| FITS header | ||
| rot_srt_axis : bool | ||
| TODO: document me |
There was a problem hiding this comment.
@leejjoon - It looks like rot_wrt_axis is used as a bool flag? OK if I change the default values of 1 / 0 to True / False everywhere? What should be the parameter description (one or two lines)?
There was a problem hiding this comment.
@leejjoon said it all (thanks!)
The intention for this parameter was to indicate the axis relative to which the rotation angle is specified (when CD/PC matrix contains skews). Therefore, it should be a number (an integer) rather than a boolean.
| *pyregion.open* takes the region name as an argument and returns a | ||
| ShapeList object, which is basically a list of Shape objects. :: | ||
| `pyregion.open` takes the region name as an argument and returns a | ||
| `~pyregion.ShapeList` object, which is basically a list of Shape objects. :: |
There was a problem hiding this comment.
@leejjoon - The Shape class should be part of the HTML API docs, right?
There was a problem hiding this comment.
If we do make it part of the API docs, should it be exposed as pyregion.parser_helper.Shape like it is now, or re-exposed from pyregion.Shape?
|
I'm merging this now. Of course, comments and PRs are still welcome if you only see this later! I noticed a few issues where cleanup would imply slight API changes (e.g. changing the name of arguments from |
|
Current API docs are here: Everyone: please review and make PRs or issues for corrections or omissions! |
This PR implements #53 and adds Sphinx automod API docs for
pyregion.It currently looks like this:
I'll keep working on this a little (cross-link getting started and API docs), but then merge it so that review / feedback becomes easier.
The main questions are which other functions / classes should be part of the public API and appear here.