ansible-documentation icon indicating copy to clipboard operation
ansible-documentation copied to clipboard

Disable sticky_navigation in sphinx-rtd-theme

Open lukaszkadlubowski opened this issue 3 months ago • 3 comments

Summary

Currently, when scrolling any page of the Ansible docs, the navigation (on the left) scrolls with the main page. Each time I need to find out what is the position of current page in the overall docs structure, or how many topics are left in the group of pages I am reading, I need to move my mouse to the left and scroll. This is especially frustrating for long pages.

In my opinion, much better user experience would be if both navigation and main content could be scrolled independently. As far as I know, such option is available in the theme.

From my perspective, current behavior does not help in anything, changing this behavior would help a lot in navigating my way through the docs.

Possible solution

As far as I know, the solution is to set sticky_navigation to false in the theme settings (as documented here), in this file

Of course I would be more than happy to contribute a PR if the proposal gets accepted.

lukaszkadlubowski avatar Sep 22 '25 13:09 lukaszkadlubowski

Thanks for your Ansible docs contribution! We talk about Ansible documentation on Matrix at #docs:ansible.im if you ever want to join us and chat about the docs! We meet on Matrix every Tuesday. See the Ansible calendar for meeting details. We welcome additions to our weekly agenda items too. You can add the dawgs-meeting tag to a forum topic to bring it up at the next meeting.

Hi @lukaszkadlubowski - this sounds like a good idea and we'd welcome a PR that tries to solve this problem. Thanks!

samccann avatar Sep 30 '25 15:09 samccann

Hi @samccann, PR is ready, seems to be working as expected.

lukaszkadlubowski avatar Oct 02 '25 11:10 lukaszkadlubowski