sphinx_rtd_theme

Sticky navigation option

#82

Merged

This PR introduces a theme option to enable "sticky" navigation. Demo: http://youtu.be/6tBrRIbxgHQ.

Features:

• Disabled by default, so all existing installs are unmodified
• User can turn on/off from conf.py via sticky_navigation boolean option
• If nav bar is taller than window, stick nav is turned off. This prevents "unreachable" spots in the nav bar. See YT video for a demo.

Thanks for the PR. I know @snide was resistent to making it default, but having it be an option seems like a win for people that want it.

Another option with the menu overflow problem is to make it individually scrollable. Though IIRC that is what we were trying to avoid when we didn't add support, so I think this is a good solution.

I'll check this out tonight. Looking at the YT vid though that's how I wanted to set it up, because I really hate scroll bars in nav, and dropping it if the nav is too tall is a good solution.

Thanks for this and your earlier subs. Appreciate the help and hope the code was clean / documented enough for you.

Nice PR. Thanks for making sure this still worked in mobile. Made some minor documentation changes.

Also, I found this to be enabled by default during testing, which is fine as long as it gracefully exists on long ones (which it did).

Also, I found this to be enabled by default during testing, which is fine as long as it gracefully exists on long ones (which it did).

Very strange. Seems like if we change the line in layout.html from

{% if theme_sticky_navigation %}

to

{% if theme_sticky_navigation == true %}

then Jinja correctly performs the boolean comparison. I don't know enough about Python to really figure out what's going on there, but might be something to keep in mind for the future. And as you said having sticky navigation enabled by default isn't really a problem.