Document "Back to top" button behavior

pydata / pydata-sphinx-theme

A clean, three-column Sphinx theme with Bootstrap for the PyData community

https://pydata-sphinx-theme.readthedocs.io

BSD 3-Clause "New" or "Revised" License

557 stars 299 forks source link

Document "Back to top" button behavior #1842

Closed melissawm closed 1 month ago

melissawm commented 1 month ago

In https://github.com/pydata/pydata-sphinx-theme/issues/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 commented 1 month ago

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