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

Split up getting started into multiple pages? #89

Closed
cdeil opened this issue Nov 30, 2016 · 2 comments
Closed

Split up getting started into multiple pages? #89

cdeil opened this issue Nov 30, 2016 · 2 comments

Comments

@cdeil
Copy link
Member

cdeil commented Nov 30, 2016

As discussed with @astrofrog in #87 (comment), the http://astropy-regions.readthedocs.io/en/latest/getting_started.html page is getting too long and we should probably split it up.

It's not quite clear how to best do it. At the moment there's ~ 16 sections.
Some are very short, is putting each on a sub-page a good solution?
Or maybe just move some of the longer ones (like masks and plotting) on sub-sections?

One point to keep in mind is that we want this to become astropy.regions, so the docs should be as similar as possible to the existing structure of Astropy core sub-package docs:
http://astropy.readthedocs.io/en/latest/

I'm pretty sure we do need docs sub-pages, because we'll also add things like MOC (healpix-based regions) here (see #62), so astropy.regions will grow in the coming months.

I'm putting this under the 0.2 milestone, and can spend some time on it, but not much.
So comments on what we should do or even help welcome!

@astrofrog
Copy link
Member

I'm working on this at #pyastro17

@astrofrog
Copy link
Member

Done in #132

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants