🐛 Prevent scroll-to-top on restart/fast buttons in the documentation

[phalberg]

Pull Request

Discussion: #1887

Description

Motivation

Upon clicking fast or restart in terminal widgets within the documentation, one would be forced to the top-of-the-page, which disrupts the user and makes it slightly harder to read documentation (perhaps).

Solution

This was a previously resolved issue in the FastAPI docs and the fix was proposed in this PR: fastapi/fastapi#13714 - which eventually got merged.

I used the same fix that was merged there, changing href = # to rather be href = javascript:void(0), which should keep consistency across the repos.

(I suggest looking at the original FastAPI PR for more technical depth on the solution, which I linked above)

AI Disclaimer

No AI was used in the process of this PR.

Checklist

• This PR links to a GitHub Discussion for the proposed code change.
• I added tests for the change.
• The new or updated tests fail on the main branch and pass on this PR.
• Coverage stays at 100%.
• The documentation explains the change if needed.

[github-actions]

📝 Docs preview

Last commit 3222610 at: https://7c266ce6.typertiangolo.pages.dev

Modified Pages

• https://7c266ce6.typertiangolo.pages.dev/js/termynal.js - (before)

[svlandeg]

I haven't reviewed/checked this in detail, but I know that @YuriiMotov did for fastapi/fastapi#13714 so this is more than likely just fine.

I can confirm that I've encountered this bug earlier in the Typer docs myself. The "being forced to the top" actually didn't always happen for me, but sometimes.

Either way, on the documentation pages produced with this PR, I can't replicate the bug anymore 🎉

Thanks @phalberg !

[tiangolo]

Nice, thank you! 🚀