search

readthedocs / sphinx_rtd_theme

Sphinx theme from Read the Docs
https://sphinx-rtd-theme.readthedocs.io/
MIT License
4.75k stars 1.73k forks source link

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

Open jdillard opened 1 year ago

jdillard commented 1 year ago

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

n-peugnet commented 10 months ago

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.