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

[docs] Show nested pages of sections as collapsible menus in the sidebar #10662

Open
choldgraf opened this issue Jul 11, 2022 · 3 comments
Open
Labels
type:docs type:enhancement enhance or introduce a new feature

Comments

@choldgraf
Copy link
Contributor

The current sidebar implementation only shows the next level of pages below the current level. This makes it difficult for users to understand the context of the current page relative to other pages, and makes it hard to quickly navigate the titles of sections across the site in order to find the information that they want.

image

I propose that the Sphinx documentation implements functionality to include sub-pages in the sidebar, so that users can navigate anywhere from anywhere via links. Examples of how this looks in Furo and the PyData theme:

Furo

chrome_FbHzgerxyh

PyData

chrome_WgQFnyS8dS

@choldgraf choldgraf added the type:enhancement enhance or introduce a new feature label Jul 11, 2022
@tk0miya
Copy link
Member

tk0miya commented Jul 16, 2022

+1; It's worth a try.

@mgeier
Copy link
Contributor

mgeier commented Jul 16, 2022

I just wanted to note that the sphinx_rtd_theme has a collapse_navigation setting (https://sphinx-rtd-theme.readthedocs.io/en/stable/configuring.html#confval-collapse_navigation) where expanding the other sections is by default deactivated and they warn about activating it:

Setting collapse_navigation to False and using a high value for navigation_depth on projects with many files and a deep file structure can cause long compilation times and can result in HTML files that are significantly larger in file size.

I think I prefer not having this feature, but if we get it, it should be possible to deactivate it to avoid the negative effects.

@AA-Turner AA-Turner added this to the some future version milestone Sep 29, 2022
@DinaAlHeyari
Copy link

Hi,
Is there a way where I can have sub-pages in the sidebar when using Sphinx for documentation?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type:docs type:enhancement enhance or introduce a new feature
Projects
None yet
Development

No branches or pull requests

5 participants