navbar align is a string and right is now an option

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_align_with_content": False,  # For testing that the navbar items snap to left properly
+    # "navbar_align": "right",  # For testing that the navbar items align properly
 }
 
 html_context = {

docs/user_guide/configuring.rst

@@ -216,17 +216,37 @@ use this pattern:
 For information about configuring the sidebar's contents, see :ref:`configure-sidebar`.
 
 
-Make navbar menu items snap to the left
-=======================================
+Configure navbar menu item alignment
+====================================
 
 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:
+page. This equals the following default configuration:
+
+.. code-block:: python
+
+   html_theme_options = {
+      ...
+      "navbar_align_with_content": "content"
+      ...
+   }
+
+If instead you'd like these items to snap to the left (closer to the logo), use this
+configuration:
+
+.. code-block:: python
+
+   html_theme_options = {
+      ...
+      "navbar_align_with_content": "left"
+      ...
+   }
+
+If you'd like these items to snap to the right of the page, use this configuration:
 
 .. code-block:: python
 
    html_theme_options = {
       ...
-      "navbar_align_with_content": False
+      "navbar_align_with_content": "right"
       ...
    }

pydata_sphinx_theme/__init__.py

@@ -75,8 +75,26 @@ def get_page_toc_object():
         except Exception:
             return {}
 
+    def navbar_align_class():
+        """Return the class that aligns the navbar based on config."""
+        align = context.get("theme_navbar_align", "content")
+        align_options = {
+            "content": ("col-lg-9", "mr-auto"),
+            "left": ("", "mr-auto"),
+            "right": ("", "ml-auto"),
+        }
+        if align not in align_options:
+            raise ValueError(
+                (
+                    "Theme optione navbar_align must be one of"
+                    f"{align_options.keys()}, got: {align}"
+                )
+            )
+        return align_options[align]
+
     context["get_nav_object"] = get_nav_object
     context["get_page_toc_object"] = get_page_toc_object
+    context["navbar_align_class"] = navbar_align_class
 
 
 def docutils_node_to_jinja(list_item, only_pages=False):

pydata_sphinx_theme/docs-navbar.html

@@ -11,8 +11,9 @@
     <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>
-    <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 navbar_class, navbar_align = navbar_align_class() %}
+    <div id="navbar-menu" class="{{ navbar_class }} collapse navbar-collapse">
+      <ul id="navbar-main-elements" class="navbar-nav {{ navbar_align }}">
         {% set nav = get_nav_object(maxdepth=1, collapse=True) %}
         {% for main_nav_item in nav %}
         <li class="nav-item {% if main_nav_item.active%}active{% endif %}">

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_align_with_content = True
+navbar_align = content

tests/test_build.py

@@ -113,15 +113,17 @@ def test_sidebar_visible(sphinx_build):
     sphinx_build.clean()
 
 
-def test_navbar_align_with_content(sphinx_build):
-    """The sidebar is shrunk when no sidebars specified in html_sidebars."""
+def test_navbar_align(sphinx_build):
+    """The navbar items align with the proper part of the page."""
     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_align_with_content=False"])
+    # Both the column alignment and the margin should be changed
+    sphinx_build.build(["-D", "html_theme_options.navbar_align=right"])
     index_html = sphinx_build.get("index.html")
     assert "col-lg-9" not in index_html.select("div#navbar-menu")[0].attrs["class"]
+    assert "ml-auto" in index_html.select("ul#navbar-main-elements")[0].attrs["class"]
     sphinx_build.clean()