pydata / pydata-sphinx-theme

A clean, three-column Sphinx theme with Bootstrap for the PyData community
https://pydata-sphinx-theme.readthedocs.io
BSD 3-Clause "New" or "Revised" License
557 stars 300 forks source link

Source buttons are not very discoverable #1870

Closed leifwalsh closed 3 weeks ago

leifwalsh commented 3 weeks ago

image

I find (and have confirmed with users of my documentation) that the Source Buttons---for finding the source code, reporting an issue, or editing the current page---are not very discoverable or intuitive. The only initial indication is the github logo, and depending on the kind of thing you're documenting, its users may not know what github is, recognize the logo, have the concept of there being "source code" for the website they're reading, or make the connection from that logo to "this is how I provide feedback about this website". It's also not clear something will happen on hover.

It would be nice to have the option to make these buttons all appear on the page without hovering, and with their explanatory text. I think there's enough horizontal space in the default layout for this, something like:

[🐱 Source] [✍🏻 Edit page] [πŸ’‘ Feedback]

This could be an option (whether to keep these buttons under the hover menu, or pull them up to page level)~, and the text of these buttons could be customizable to match the expectations of the audience.~ (These are already customizable. Nice!)

I'd be willing/interested to contribute such a change, but I'd like to discuss the idea first, and would probably appreciate a pointer about where in the codebase to start.

12rambau commented 3 weeks ago

The image you send is not build with our template but with Jupyter book. I guess you'll want to move this request to their repository:

https://github.com/executablebooks/sphinx-book-theme

Not that in Pydata-Sphinx-theme the buttons are displayed in the right sidebar without hovering.

trallard commented 3 weeks ago

I will go ahead and close the issue since it is not PST related

leifwalsh commented 1 week ago

Whoops, thanks!