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

Header links: drop-down menus? #1489

Open
dbitouze opened this issue Oct 2, 2023 · 8 comments
Open

Header links: drop-down menus? #1489

dbitouze opened this issue Oct 2, 2023 · 8 comments
Labels
tag: component Issues or improvements associated with a given component in the theme

Comments

@dbitouze
Copy link
Contributor

dbitouze commented Oct 2, 2023

It would be interesting if the header links could be drop-down menus allowing the user to access all the secondary entries for each of them, without having to click on them.

@eshalakhotia
Copy link

Hi, was this issue ever addressed? I also would like this ability

@trallard
Copy link
Collaborator

Are you suggesting that all the navbar links (e.g. user guide, contributing, ... in the screenshot) be turned into dropdown boxes containing all the sections and subsections within them?

The_PyData_Sphinx_Theme_—_PyData_Theme_0_14_5dev0_documentation

If that is the proposal, I am not sure this would be a rather practical navigation user experience. Plus, considering that some sections can have many subsections (and sub-subsections) the navigation pattern and display of such dropdown would be somewhat problematic, particularly for mobile versions and for users that do not use mice or pointing devices on desktops.

@dbitouze
Copy link
Contributor Author

@trallard Indeed, that is the proposal. It's something I appreciate on sites I'm visiting: accessing all the secondary entries, without having to click on them.

Maybe this could be provided but optional.

@drammock
Copy link
Collaborator

I can see why some users might find this desirable (though only if the dropdowns were 1 level deep; I agree with @trallard that including sub-sub-entries makes the UX too hard to manage for anyone lacking good vision or ability to use a mouse). That said, I'm afraid this is very low priority (for me at least), as there are many bugs and improvements ahead of it in the queue, and this proposal doesn't fix anything broken (it's a new option for something that already is functional). I'd review it if someone comes up with a PR, but I won't be implementing this myself.

@eshalakhotia
Copy link

@drammock There actually is a PR for this: #1165
If you would be able to review this and integrate it would be very helpful

@eshalakhotia
Copy link

@drammock Is there any update for the dropdown links capability?

@drammock
Copy link
Collaborator

Is there any update for the dropdown links capability?

sadly not. The PR you linked to (#1165) is stale (it would take some work to get it mergable) and as I said above

I'm afraid this is very low priority (for me at least), as there are many bugs and improvements ahead of it in the queue, and this proposal doesn't fix anything broken (it's a new option for something that already is functional).

I'm trying to arrange my schedule/funding sources so that I have more time for PST maintenance/improvement, but haven't succeded yet.

@CAM-Gerlach
Copy link

FWIW, this is something we'd really like to see with for Spyder docs with our migration to the upstream PST from our heavily customized and reworked old forked version, particularly given the major change to use top bar navigation (which the older PST version we'd forked did not) and expose the second-level index pages, with the consequences described in #90 . (Note we also considered migrating to Furo instead, which we concluded had some significant advantages over this theme in both that department and overall polish, but the lack of version and translation support was a hard blocker on that, as well as a bus factor of one on very busy maintainer.)

In particular, the specific functionality we'd be looking for is a theme option (presumably off by default) that works like the default MkDocs theme, making the first child toctree level visible in a dropdown just like the one under "More", which also conveniently allows us to bypass our (mostly empty) index pages for the categories. (To note, the above-linked PR addresses a related but separate feature from what we and most people appear to be asking here, allowing drop-down lists for external links).

Unfortunately, we don't have the funded bandwidth to work on this immediately, particularly since we'll be focusing on helping implement #507 as our first priority, along with potentially other issues on our end (and wouldn't want to divert limited review bandwidth from that, either). Longer term this could be something we could potentially look at assisting with, since it would significantly improve the usability of the theme on less extensive sites like ours, without requiring the theme to support multiple navigation/layout modes.

@trallard trallard added the tag: component Issues or improvements associated with a given component in the theme label Apr 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
tag: component Issues or improvements associated with a given component in the theme
Projects
None yet
Development

No branches or pull requests

5 participants