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 back third level to documentation TOC tree #25131

Closed
neili02 opened this issue Feb 4, 2019 · 3 comments
Closed

Add back third level to documentation TOC tree #25131

neili02 opened this issue Feb 4, 2019 · 3 comments
Labels
Milestone

Comments

@neili02
Copy link

neili02 commented Feb 4, 2019

I use the online docs quite a bit and am wondering what is the rationale for the new format of the Table of Contents. The new format nicely compresses the main TOC tree into reasonable starting groups, however it detrimentally removes a third level of the tree that is very useful for quickly identifying and navigating to subsections of individual User Guide main topics.

For example the new format now only has User Guide>MultiIndex / Advanced Indexing

MultiIndex / Advanced Indexing itself is a very long page, as are most others, with many different sub-topics. Previously these subtopics were listed as part of the TOC tree. I hope this third level will return as one now has to scroll through lengthy pages to try and find desired content. This can be particularly painful depending on the device from which you access the docs.

Can't the third level be added as an expansion of the tree that occurs upon click? This would allow the new compact organization to be maintained.

What I had in mind is just to add back the additional level that was previously present. For example:

User Guide now expands to reveal:

User Guide
      IO Tools (Text, CSV, HDF5, …)
      Indexing and Selecting Data
      MultiIndex / Advanced Indexing

Clicking on MultiIndex/ Advanced Indexing should show as previously

User Guide
      IO Tools (Text, CSV, HDF5, …)
      Indexing and Selecting Data
      MultiIndex / Advanced Indexing
            Hierarchical indexing (MultiIndex)
                ...
            Advanced indexing with hierarchical index
                ...

Thanks for all the work being done to maintain and improve this great tool.

@TomAugspurger
Copy link
Contributor

Moving the top-level of the TOC tree to a secondary navigation pane (horizontal across the top) would help a lot here I think.

@dpitch40
Copy link

dpitch40 commented Mar 4, 2019

I will second this.

My team recently upgraded the version of Pandas we use, and while the improved functionality of the module itself is great, I'm finding the docs annoying to use. Previously the sidebar index showed (if anything) too much; now it shows too little. Compare, for example, the Essential Basic Functionality docs in 0.20.3 vs. 0.24.0. The 0.20.3 version is a little long, but makes it fairly easy to navigate to any part of the lengthy page to find the section you need. The index for 0.24.0, only shows links that were already on the front page and is virtually useless for navigating the page I find myself in.

On the other hand, the index for the 0.20.3 API Reference doc page is actually longer than the page itself (at least on my browser, due to wrapping) and thus equally useless for navigation, and I find the 0.24.0 version more useful.

@jorisvandenbossche
Copy link
Member

@dpitch40 I fully agree. See also #25134. I think the best solution is what I wrote in the last paragraph of the comment in #25134 (comment).
I will try to include this in 0.24.2.

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

No branches or pull requests

4 participants