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

Design: (right sidebar) Change "On this page" to "Contents" (or "Table of Contents") #145

Closed
pradyunsg opened this issue Aug 6, 2020 · 7 comments · Fixed by #159
Closed
Labels
enhancement New feature or request

Comments

@pradyunsg
Copy link
Member

pradyunsg commented Aug 6, 2020

Describe the changes you'd like

Title says it all.

Describe alternatives you've considered

None. Status quo is OK. Suggested change is nicer, but I'm obviously biased. :)

Additional context

This seems to be the phrasing for the in-page-navigation-tree on all 3-column documentation-oriented themes that I know of (except this theme and the pydata theme). Sample Screenshots: https://gist.github.com/pradyunsg/eeb74ac5b580d502c3d0e248310f273f

I'm happy to file a PR for this, if there's interest in this idea. :)

@pradyunsg pradyunsg added the enhancement New feature or request label Aug 6, 2020
@choldgraf
Copy link
Member

I think it's a reasonable idea. My question is what those themes call the left sidebar, in that case. I just wanna make sure that our naming is consistent so we don't confuse the mental model that folks have.

@pradyunsg
Copy link
Member Author

Navigation is what I've seen most often (the default Sphinx theme, and the entire lineage of themes that led to it, uses that).

@choldgraf
Copy link
Member

Cool - then we should just make sure it's consistent in our docs etc, and I'm +1 on making it "contents" or "table of contents", whichever you think makes most sense.

@chrisjsewell
Copy link
Member

not table of contents (that confuses it with the left side bar)

@pradyunsg
Copy link
Member Author

"Contents" it is. :)

@chrisjsewell
Copy link
Member

yeh or "Page Contents", no strong opinion though

@jorisvandenbossche
Copy link

BTW, feel free to also propose such changes in the pydata-sphinx-theme!

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

Successfully merging a pull request may close this issue.

4 participants