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

UX: Inconsistent use of plus [+] symbol in sidebar #1524

Open
jdillard opened this issue Sep 7, 2023 · 1 comment
Open

UX: Inconsistent use of plus [+] symbol in sidebar #1524

jdillard opened this issue Sep 7, 2023 · 1 comment
Labels
Bug A bug Needed: replication Bug replication is required

Comments

@jdillard
Copy link

jdillard commented Sep 7, 2023

Problem

When you go to the theme's docs and navigate to 3. Paragraph Level Markup it adds a minus [-] symbol to the left of the heading letting you know it is expanded, and when you collapse it, it changes to a plus [+] symbol letting you know it can be expanded. In contrast, the 1. Structural Elements and 2. Structural Elements 2 headings lack a plus [+] symbol, even though they are expandable, leading to a user believing that they might not be expandable.

image

Reproducible Project

This is the URL to the above example: https://sphinx-rtd-theme.readthedocs.io/en/stable/demo/demo.html

Expected Results

It seems like it would be better to consistently use the plus [+] symbol on all top-level headings that are expandable, the same way it does for sub-level headings, like 3.4. Blocks and 3.5. Sidebar.

Environment Info

  • Python Version: latest
  • Sphinx Version: latest
  • RTD Theme Version: latest
@jdillard jdillard added Bug A bug Needed: replication Bug replication is required labels Sep 7, 2023
@jdillard jdillard changed the title Inconsistent use of plus [+] symbol in sidebar UX: Inconsistent use of plus [+] symbol in sidebar Sep 7, 2023
@n-peugnet
Copy link

n-peugnet commented Nov 27, 2023

I think this is simply the result of the default value of the collapse_navigation config value.

In fact with this value that to true, the entries that don't have the [+] icon are not really expandable the same way the others are. The HTML of the current page does not include the content of these TOC entries, so it can not be toggled without loading another page.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bug A bug Needed: replication Bug replication is required
Projects
None yet
Development

No branches or pull requests

2 participants