Right navbar column skips the section clicked

[dylanh724]

This was originally reported for sphinx-book-theme that seems to also have this bug on their own docs site (but, iirc, their main theme comes from this repo). See a full report with GIFs and links here:

executablebooks/sphinx-book-theme#853

Or repro the bug yourself here on your own docs:

https://pydata-sphinx-theme.readthedocs.io/en/stable/examples/kitchen-sink/admonitions.html#attention

1. On the right column, click a header in the middle
2. Now click the header +1 up. It will land on +2 up.

---

Edited by @trallard to copy content from the original issue in the executablebooks repo

context
When I click a right column child header, it skips to the section above or below my cursor and awkwardly highlights the incorrect section:

expectation
When I click on a header anchor link on the right column nav, I expect it to go straight there and highlight the correctly selected link.

[electric-coder]

I confirm this happens using Firefox 129.0.1 (64-bit) on Windows 10.

I had noticed this before but didn't bother reporting.

[dbitouze]

I don't confirm this using Firefox 129.0.2 (64 bits) on GNU/Linux.

[ramevaf]

Could this be related to Issue #1889 ?

[dylanh724]

Could this be related to Issue #1889 ?

Very possible!

[trallard]

@dylanh724 or @electric-coder, what version of the PyData Sphinx Theme are you using?

I can see the behaviour on the admonition page as reported in #1965 (comment), but I cannot reproduce this on other pages (I tried various within the user and community guides in our docs in dev and 0.15.4, see the video below)

Sep-03-2024.15-12-31.mp4

@gabalafou have you seen this before?

Could this be related to Issue #1889 ?

This should be unrelated to the above issue tho.

[nishikantparmariam]

JFYI: Another reproducer: #2053 (comment)

[dylanh724]

@dylanh724 or @electric-coder, what version of the PyData Sphinx Theme are you using?

I'm using sphinx-book-theme 1.1.3 (forks off from this theme - and since it happens with your docs, it doesn't seem to be the spinoff theme bug)

I wonder if this only happens with nested headers? Unfortunately, I'm out of time to test further - but hope this helps.