Skip to content

Document "Back to top" button behavior #1842

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
Closed
melissawm opened this issue May 30, 2024 · 1 comment · Fixed by #1843
Closed

Document "Back to top" button behavior #1842

melissawm opened this issue May 30, 2024 · 1 comment · Fixed by #1843

Comments

@melissawm
Copy link
Contributor

In #1497, the back-to-top button config option was exposed to users, but this is not documented except for the References configuration section. I propose adding a section either in "Theme Structure and Layout" or the "Theme-specific elements" pages with a note about this config option.

I'm happy to submit a PR if this is reasonable. Thanks!
@drammock
Copy link
Collaborator

I would put it as a new page under "user interface" (alongside announcement banners, version switcher, search bar, etc). PR welcome!

@melissawm melissawm mentioned this issue May 30, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add documentation for the back_to_top_button config option melissawm/pydata-sphinx-theme
2 participants
@drammock @melissawm