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

Documentation: Enhance left navigation area to always display complete tree. #2457

Closed
amitmurthy opened this issue Mar 4, 2013 · 5 comments
Labels
docs This change adds or pertains to documentation

Comments

@amitmurthy
Copy link
Contributor

In the documentation pages, for example in http://docs.julialang.org/en/release-0.1/manual/ ,

the left navigation area only shows Current Topic (with immediate nodes), Prev Topic, Next Topic and a Search box.

Suggest to replace Current, Prev and Next with the complete documentation tree, where any section at any level can be collapsible, i.e., if one chooses, direct links to all the pages in the documentation is always visible.

@ViralBShah
Copy link
Member

I have often found myself wanting to jump to any section of the manual. It would be nice to have the full collapsible ToC in the sidebar, if such a thing is possible with readthedocs.

@pao
Copy link
Member

pao commented Mar 4, 2013

I think this is a good idea.

See also #2123, #2147.

@vtjnash
Copy link
Member

vtjnash commented Aug 28, 2013

This is probably possible. However, I don't think it is a generally good idea. We have a large number of subsections (tens? hundreds?), which I think would quickly become unwieldy if expanded. The search bar is readily accessible for all other queries. Thus, I propose this be closed. Or we could add a separate table-of-contents page -- that should be very easy with sphinx TOC markup.

@ViralBShah
Copy link
Member

I think it would be nice if the navigation bar simply had the entire ToC at Chapter level and section level expanded for the chapter that is being viewed. Subsections is not really necessary.

@nolta
Copy link
Member

nolta commented Mar 13, 2014

This is pretty much implemented now.

@nolta nolta closed this as completed Mar 13, 2014
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs This change adds or pertains to documentation
Projects
None yet
Development

No branches or pull requests

5 participants