Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Scrollspy is broken for API page anchors #1026

Closed
12rambau opened this issue Oct 19, 2022 · 1 comment · Fixed by #1208
Closed

Scrollspy is broken for API page anchors #1026

12rambau opened this issue Oct 19, 2022 · 1 comment · Fixed by #1208
Labels
kind: bug Something isn't working

Comments

@12rambau
Copy link
Collaborator

I checked our documentation on this page:
https://pydata-sphinx-theme.readthedocs.io/en/latest/examples/kitchen-sink/api.html

When scrolling down the bd-toc is never updated.

Looking at this page:
https://pydata-sphinx-theme.readthedocs.io/en/latest/examples/api.html#exceptions

scrolling down after "exception" will never activate eight() and the other functions. I don't know why but the theme seems to no react to api elements
@choldgraf choldgraf changed the title the scrollspy is broken for api elements Scrollspy is broken for API page anchors Nov 9, 2022
@12rambau 12rambau added the kind: bug Something isn't working label Nov 10, 2022
@12rambau 12rambau mentioned this issue Feb 21, 2023
Open
bheberlein added a commit to bheberlein/pydata-sphinx-theme that referenced this issue Feb 21, 2023
@bheberlein
Override generation of id & href attributes for API documentation
a86ecc1 
This will replace dots with underscores in qualified names of Python modules & functions (e.g. `mypackage.mymodule.myfunc`), allowing ScrollSpy to identify these tags as navigation targets.

Addresses pydata#1207 and fixes pydata#1026
@bheberlein bheberlein mentioned this issue Feb 21, 2023
Merged
bheberlein added a commit to bheberlein/pydata-sphinx-theme that referenced this issue Feb 23, 2023
@bheberlein
Override generation of id & href attributes for API documentation
1a8afd4 
This will replace dots with underscores in qualified names of Python modules & functions (e.g. `mypackage.mymodule.myfunc`), allowing ScrollSpy to identify these tags as navigation targets.

Addresses pydata#1207 and fixes pydata#1026
12rambau added a commit that referenced this issue Apr 25, 2023
@bheberlein @12rambau
Override generation of id & href attributes for API documentation (…
1522b84 
…#1208)

* Override generation of `id` & `href` attributes for API documentation

This will replace dots with underscores in qualified names of Python modules & functions (e.g. `mypackage.mymodule.myfunc`), allowing ScrollSpy to identify these tags as navigation targets.

Addresses #1207 and fixes #1026

* Apply linter corrections & add comment referencing open Sphinx issue

---------

Co-authored-by: Rambaud Pierrick <12rambau@users.noreply.github.com>
@tpoint75
Copy link

tpoint75 commented May 3, 2023

now my <a class="reference internal"/a>which I created with :meth:class.function are broken! They have still the dots in href..

@wyli wyli mentioned this issue Jun 8, 2023
Open
@drammock drammock mentioned this issue Sep 14, 2023
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
kind: bug Something isn't working
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Override generation of id & href attributes for API documentation bheberlein/pydata-sphinx-theme
2 participants
@tpoint75 @12rambau