Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add first version of API docs #32

Merged
merged 3 commits into from
Jun 23, 2016
Merged

Add first version of API docs #32

merged 3 commits into from
Jun 23, 2016

Conversation

cdeil
Copy link
Member

@cdeil cdeil commented Jun 10, 2016

At PyAstro16 @joleroi set up online docs for this regions repo here:
http://astropy-regions.readthedocs.io/en/latest/

This pull request adds a first version of the API docs.

There's a few warnings in the API docs build like this that I don't know how to fix.
@keflavich @astrofrog or @bsipocz - Do you know how to address those? If yes, can you make a PR against this PR?

<autosummary>:None: WARNING: toctree contains reference to nonexisting document 'api/regions.shapes.PixelRegion'
<autosummary>:None: WARNING: toctree contains reference to nonexisting document 'api/regions.shapes.SkyRegion'
None:None: WARNING: toctree contains reference to nonexisting document 'api/regions.shapes.PixelRegion'
None:None: WARNING: toctree contains reference to nonexisting document 'api/regions.shapes.SkyRegion'

https://gist.github.com/cdeil/539490416ffee012f3a1081b90940168

If I don't hear back I might merge this soon, because something with warnings is better than nothing. :-)

@cdeil cdeil mentioned this pull request Jun 10, 2016
@cdeil
Copy link
Member Author

cdeil commented Jun 10, 2016

How about pulling in regions.core, regions.io and regions.shapes into the top-level regions namespace? I don't think the sub-package hierarchy is very useful here because the package isn't terribly large?

@astrofrog
Copy link
Member

@cdeil - I quite like the hierarchy in terms of the code files, but I have no objections to importing the classes into the top-level in terms of public API.

@cdeil
Copy link
Member Author

cdeil commented Jun 23, 2016

@cdeil - I quite like the hierarchy in terms of the code files, but I have no objections to importing the classes into the top-level in terms of public API.

@astrofrog - I'm making this change now.

If anyone objects, please speak up now or later ... we can always change back should people be unhappy with the simple single-namespace solution.

@cdeil
Copy link
Member Author

cdeil commented Jun 23, 2016

screen shot 2016-06-23 at 16 22 35

OK?

@larrybradley
Copy link
Member

👍

@cdeil cdeil added this to the 0.1 milestone Jun 23, 2016
@cdeil cdeil self-assigned this Jun 23, 2016
@cdeil
Copy link
Member Author

cdeil commented Jun 23, 2016

I'm merging this now.

If you only see this later: Feedback is still very welcome!

@cdeil cdeil merged commit 2d3373a into astropy:master Jun 23, 2016
@cdeil cdeil mentioned this pull request Jun 23, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants