align_with_content

Author: choldgraf

docs/conf.py

@@ -70,7 +70,7 @@
     "twitter_url": "https://twitter.com/pandas_dev",
     "use_edit_page_button": True,
     "show_toc_level": 1,
-    # "navbar_snap_left": True,  # For testing that the navbar items snap to left properly
+    "navbar_align_with_content": True,  # For testing that the navbar items snap to left properly
 }
 
 html_context = {

docs/user_guide/configuring.rst

@@ -219,14 +219,14 @@ For information about configuring the sidebar's contents, see :ref:`configure-si
 Make navbar menu items snap to the left
 =======================================
 
-By default, the navigation bar menu items will begin in-line with the content on your
+By default, the navigation bar menu items will align with the content on your
 page. If instead you'd like these items to snap to the left (closer to the logo), then
 use the following configuration:
 
 .. code-block:: python
 
    html_theme_options = {
       ...
-      "navbar_snap_left": True
+      "navbar_align_with_content": False
       ...
    }

pydata_sphinx_theme/docs-navbar.html

@@ -11,13 +11,7 @@
     <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbar-menu" aria-controls="navbar-menu" aria-expanded="false" aria-label="Toggle navigation">
         <span class="navbar-toggler-icon"></span>
     </button>
-
-    {% if theme_navbar_snap_left in [True, "True"] %}
-      {% set navbar_col_class = "col-11" %}
-    {% else %}
-      {% set navbar_col_class = "col-lg-9" %}
-    {% endif %}
-    <div id="navbar-menu" class="{{ navbar_col_class }} collapse navbar-collapse">
+    <div id="navbar-menu" class="{% if theme_navbar_align_with_content in [True, 'True'] %}col-lg-9 {% endif %}collapse navbar-collapse">
       <ul id="navbar-main-elements" class="navbar-nav mr-auto">
         {% set nav = get_nav_object(maxdepth=1, collapse=True) %}
         {% for main_nav_item in nav %}

pydata_sphinx_theme/theme.conf

@@ -16,4 +16,4 @@ search_bar_text = Search the docs ...
 search_bar_position = sidebar
 navigation_with_keys = True
 show_toc_level = 1
-navbar_snap_left = False
+navbar_align_with_content = True

tests/test_build.py

@@ -113,15 +113,15 @@ def test_sidebar_visible(sphinx_build):
     sphinx_build.clean()
 
 
-def test_navbar_snap_left(sphinx_build):
+def test_navbar_align_with_content(sphinx_build):
     """The sidebar is shrunk when no sidebars specified in html_sidebars."""
     sphinx_build.copy()
 
     sphinx_build.build()
     index_html = sphinx_build.get("index.html")
     assert "col-lg-9" in index_html.select("div#navbar-menu")[0].attrs["class"]
 
-    sphinx_build.build(["-D", "html_theme_options.navbar_snap_left=True"])
+    sphinx_build.build(["-D", "html_theme_options.navbar_align_with_content=True"])
     index_html = sphinx_build.get("index.html")
     assert "col-11" in index_html.select("div#navbar-menu")[0].attrs["class"]
     sphinx_build.clean()