Skip to content

Make toctree on front page more concise - #278

Merged
astrofrog merged 7 commits into
astropy:masterfrom
astrofrog:docs/fix-toctree-level
Jun 13, 2012
Merged

astrofrog merged 7 commits into
astropy:masterfrom
astrofrog:docs/fix-toctree-level

Conversation

@astrofrog

Copy link
Copy Markdown
Member

Given that all sub-packages are going to have the same substructure, I think it doesn't make sense to expand the full TOC tree on the front page. This also makes it hard for users to see all the functionality at a glance. The present PR changes the TOC-tree level to 1 for the front page, giving something that I think is much more readable without much scrolling, and makes it easier for users to see all the functionality.

Preview: http://astrofrog.github.com/astropy/

cc @taldcroft @eteq @mdboom @iguananaut

@taldcroft

Copy link
Copy Markdown
Member

YES, super!

@mdboom

mdboom commented Jun 13, 2012

Copy link
Copy Markdown
Contributor

+1

@embray

embray commented Jun 13, 2012

Copy link
Copy Markdown
Member

While we're at it, could we change "Logging System Documentation" to just "Logging System"? The last word is redundant.
And yes, I'll fix astropy.io.fits. I'll do that today.

@astrofrog

Copy link
Copy Markdown
Member Author

@iguananaut - done

@eteq

eteq commented Jun 13, 2012

Copy link
Copy Markdown
Member

Looks fine to me - one other thing you might do while you're fiddling with the index page: switch the order of "Logging System" and the configs? Right now it just looks weird because "Logging System" is the only one that doesn't have a package name.

@astrofrog

Copy link
Copy Markdown
Member Author

@eteq - I was thinking that too, I'll fix that.

@astrofrog

Copy link
Copy Markdown
Member Author

Done - ready to merge?

@eteq

eteq commented Jun 13, 2012

Copy link
Copy Markdown
Member

Looks fine to me.

astrofrog added a commit that referenced this pull request Jun 13, 2012
Make toctree on front page more concise
@astrofrog
astrofrog merged commit eb9e638 into astropy:master Jun 13, 2012
keflavich pushed a commit to keflavich/astropy that referenced this pull request Oct 9, 2013
@astrofrog
astrofrog deleted the docs/fix-toctree-level branch July 5, 2016 18:46
astrofrog pushed a commit to astrofrog/astropy that referenced this pull request Jun 12, 2019
Move numpydoc and sphinx-automodapi to astropy_helpers.extern
astrofrog added a commit to astrofrog/astropy that referenced this pull request Jun 12, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants