Re-organise docs pages in a slightly better way

astropy / pyregion

ds9 region parser for python

https://pyregion.readthedocs.io

MIT License

39 stars 38 forks source link

Re-organise docs pages in a slightly better way #82

Closed cdeil closed 7 years ago

cdeil commented 7 years ago

This PR re-organises the docs pages in a slightly better way.

Astropy and most affiliated packages call the tutorial intro "getting started" and the installation instructions page "installation", so this is just slightly more standard.

And by avoiding the second toctree the navigation tree on the side works lightly better IMO, it now looks like this:

screen shot 2016-08-02 at 08 58 47

@leejjoon - OK with you?

(I'll now start a new PR to add Sphinx autodoc API docs.)

coveralls commented 7 years ago

Coverage remained the same at 50.662% when pulling 9ee0c65ba82ef5bd620366416cf699dfa4bf4b79 on cdeil:docs-org into 511d6da0a9034b67db14ddc6c5281648cf789957 on astropy:master.

cdeil commented 7 years ago

I'll just merge this now so that I can continue with the API docs. Comments / suggestions to improve the docs still welcome or course!