fix: allow user to control the back-to-top button presence (pydata#1616)

* fix: put the btt button closer to age bottom

* test: remove the btt button to check

* test: fallback to default behaviour

* refactor: rollback to previous state

* use proper variable name

* Update src/pydata_sphinx_theme/theme/pydata_sphinx_theme/layout.html

---------

Co-authored-by: Daniel McCloy <[email protected]>

Author: 2 people

docs/conf.py

@@ -189,6 +189,7 @@
         "version_match": version_match,
     },
     "navigation_with_keys": False,
+    # "back_to_top_button": False,
     # "search_bar_position": "navbar",  # TODO: Deprecated - remove in future version
 }
 

src/pydata_sphinx_theme/assets/styles/base/_base.scss

@@ -172,7 +172,7 @@ pre {
   z-index: $zindex-tooltip;
   position: fixed;
   display: none;
-  top: 80vh;
+  top: 90vh;
   left: 50vw;
   transform: translate(-50%);
   color: var(--pst-color-secondary-text);

src/pydata_sphinx_theme/theme/pydata_sphinx_theme/layout.html

@@ -43,11 +43,13 @@
   {# A tiny helper pixel to detect if we've scrolled #}
   <div id="pst-scroll-pixel-helper"></div>
 
+  {%- if theme_back_to_top_button %}
   {# the scroll to top button #}
   <button type="button" class="btn rounded-pill" id="pst-back-to-top">
     <i class="fa-solid fa-arrow-up"></i>
     {{ _("Back to top") }}
   </button>
+  {%- endif %}
 
   {# checkbox to toggle primary sidebar #}
   <input type="checkbox"

src/pydata_sphinx_theme/theme/pydata_sphinx_theme/theme.conf

@@ -37,6 +37,7 @@ pygment_light_style = a11y-high-contrast-light
 pygment_dark_style = a11y-high-contrast-dark
 logo =
 surface_warnings = True
+back_to_top_button = True
 
 # Template placement in theme layouts
 navbar_start = navbar-logo