[HTML Theme]: Add "Navigate to Top" Button

[kavania2002]

Feature

• Feature

Purpose

• Provide a quick and convenient way for users to return to the top of the page
• Eliminate the need for excessive scrolling, especially on long pages
• Improve overall user experience and accessibility

Detail

• Inspired by the navigation feature in the Furo theme
• Implementation:
  • Custom CSS for styling the button
  • Custom JavaScript for button functionality
  • Button positioned at the bottom centre of the page
  • Smooth scrolling animation when the button is clicked
• Current behaviour: Scrolls to the top of the page when clicked

Relates

• Resolves [HTML theme] add "Navigate to the Top" button #12558

[picnixz]

Could we have some visual examples? maybe a GIF showing how it renders?

Also, how do you enable / disable the feature actually? I think you need to setup the configuration file of the theme as well with an additional boolean (and document it as well in the RST files)

[kavania2002]

I haven't added anything that enable/disable this button. I'll have to dive deep to see how this can be achieved. Can you provide me some guidance for the same?

And, currently it looks like this -

navigate_to_top_recording.mov

[picnixz]

I didn't forget about you but I am travelling this week. I'll be able to provide guidance in 10 days or so (or someone else can if they have time). So don't worry about me not replying! By the way, I like how it currently renders (we need to make the button a bit.. less crude but the overall idea is fine).

[mgeier]

I don't think this should be part of basic, but it would be fine to add this to some of the built-in themes.

[mgeier]

I don't think this is something we should force onto every derived theme.

[AA-Turner]

HTML specifies the #top anchor which seems simpler than this script.

[AA-Turner]

I agree with Matthias (@mgeier) that this isn't wanted in every theme. Perhaps you could propose a PR to add it to sphinx13 and add a recipe for it to the docs in a tutorial?

I'll close this PR for now, though.

A