File: back-to-top.md

package info (click to toggle)
pydata-sphinx-theme 0.16.1%2Bdfsg-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 6,088 kB
  • sloc: python: 2,796; javascript: 701; makefile: 42; sh: 12
file content (13 lines) | stat: -rw-r--r-- 461 bytes parent folder | download 
1
2
3
4
5
6
7
8
9
10
11
12
13
 
# Back to Top button

The `Back to Top` button is a floating button that appears when you scroll down a page, and allows users to quickly return to the top of the page.

To control the visibility of the `Back to Top` button, you can use the `html_theme_options["back_to_top_button"]` configuration value in your `conf.py` file.

```python
html_theme_options = {
    "back_to_top_button": False,
}
```

The default value for this configuration option is `True`.