Add Sphinx automod API docs

astropy / pyregion

ds9 region parser for python

https://pyregion.readthedocs.io

MIT License

39 stars 38 forks source link

Add Sphinx automod API docs #83

Closed cdeil closed 7 years ago

cdeil commented 7 years ago

This PR implements #53 and adds Sphinx automod API docs for pyregion.

It currently looks like this:

screen shot 2016-08-02 at 09 26 07

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.

coveralls commented 7 years ago

Coverage increased (+0.03%) to 50.689% when pulling 1a216df8cf8098ffc5bf85a48cd1bed4a0dc68df on cdeil:api-docs into d9133d64becb43a039a76448d60452e8e940343e on astropy:master.

coveralls commented 7 years ago

Coverage decreased (-0.0007%) to 50.662% when pulling 2629ac504e406b97593df2541d47278542893212 on cdeil:api-docs into d9133d64becb43a039a76448d60452e8e940343e on astropy:master.

cdeil commented 7 years ago

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 s to something more obvious). I'll split those out into separate issues and PRs so that @leejjoon and others can comment whether they are OK changes for 1.2 or whether they should be avoided completely or delayed to a possible 2.0 in the future for better backward compatibility.

coveralls commented 7 years ago

Coverage increased (+0.05%) to 50.714% when pulling 40805a1c2fc52296d6db06e68996ab0724912931 on cdeil:api-docs into d9133d64becb43a039a76448d60452e8e940343e on astropy:master.

cdeil commented 7 years ago

Current API docs are here: http://pyregion.readthedocs.io/en/latest/api.html

Everyone: please review and make PRs or issues for corrections or omissions!