🐛 Fix in-page headers incorrectly appearing in navbar (#307)

Author: jorisvandenbossche

pydata_sphinx_theme/__init__.py

@@ -41,6 +41,14 @@ def generate_nav_html(kind, **kwargs):
         for li in soup("li", {"class": "current"}):
             li["class"].append("active")
 
+        # Remove navbar/sidebar links to sub-headers on the page
+        for li in soup.select("li"):
+            # Remove
+            if li.find("a"):
+                href = li.find("a")["href"]
+                if "#" in href and href != "#":
+                    li.decompose()
+
         if kind == "navbar":
             # Add CSS for bootstrap
             for li in soup("li"):
@@ -49,13 +57,6 @@ def generate_nav_html(kind, **kwargs):
             out = "\n".join([ii.prettify() for ii in soup.find_all("li")])
 
         elif kind == "sidebar":
-            # Remove sidebar links to sub-headers on the page
-            for li in soup.select("li.current ul li"):
-                # Remove
-                if li.find("a"):
-                    href = li.find("a")["href"]
-                    if "#" in href and href != "#":
-                        li.decompose()
 
             # Join all the top-level `li`s together for display
             current_lis = soup.select("li.current.toctree-l1 li.toctree-l2")

tests/sites/test_navbar_no_in_page_headers/conf.py

@@ -0,0 +1,14 @@
+# -- Project information -----------------------------------------------------
+
+project = "PyData Tests"
+copyright = "2020, Pydata community"
+author = "Pydata community"
+
+master_doc = "index"
+
+# -- General configuration ---------------------------------------------------
+
+html_theme = "pydata_sphinx_theme"
+
+html_copy_source = True
+html_sourcelink_suffix = ""

tests/sites/test_navbar_no_in_page_headers/index.rst

@@ -0,0 +1,7 @@
+test-navbar-in-page-headers
+===========================
+
+.. toctree::
+
+   page1
+   page2

tests/sites/test_navbar_no_in_page_headers/page1.rst

@@ -0,0 +1,19 @@
+Page 1
+======
+
+Some text
+
+Another header
+==============
+
+Some text
+
+Sub-header
+----------
+
+Some text
+
+And another one
+===============
+
+Some text

tests/sites/test_navbar_no_in_page_headers/page2.rst

@@ -0,0 +1,2 @@
+Page 2
+======

tests/test_build.py

@@ -145,3 +145,12 @@ def test_navbar_align_right(sphinx_build_factory):
     index_html = sphinx_build.html_tree("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"]
+
+
+def test_navbar_no_in_page_headers(sphinx_build_factory, file_regression):
+    # https://github.com/pandas-dev/pydata-sphinx-theme/issues/302
+    sphinx_build = sphinx_build_factory("test_navbar_no_in_page_headers").build()
+
+    index_html = sphinx_build.html_tree("index.html")
+    navbar = index_html.select("ul#navbar-main-elements")[0]
+    file_regression.check(navbar.prettify(), extension=".html")

tests/test_build/test_navbar_no_in_page_headers.html

@@ -0,0 +1,12 @@
+<ul class="navbar-nav mr-auto" id="navbar-main-elements">
+ <li class="toctree-l1 nav-item">
+  <a class="reference internal nav-link" href="page1.html">
+   Page 1
+  </a>
+ </li>
+ <li class="toctree-l1 nav-item">
+  <a class="reference internal nav-link" href="page2.html">
+   Page 2
+  </a>
+ </li>
+</ul>