FIX empty primary sidebar showing up

src/pydata_sphinx_theme/toctree.py

@@ -39,7 +39,7 @@
 
         ancestors = [*_get_toctree_ancestors(app.env.toctree_includes, pagename)]
     else:
         ancestors = toctree.get_toctree_ancestors(pagename)
     try:
         out = ancestors[-startdepth]
     except IndexError:
@@ -71,10 +71,6 @@
         )
         if ancestorname is None:
             return True  # suppress
-        if kwargs.get("includehidden", False):
-            # if ancestor is found and `includehidden=True` we're guaranteed there's a
-            # TocTree to be shown, so don't suppress
-            return False
 
         # we've found an ancestor page, but `includehidden=False` so we can't be sure if
         # there's a TocTree fragment that should be shown on this page; unfortunately we
@@ -273,14 +269,14 @@
             HTML string (if kind == "sidebar") OR BeautifulSoup object (if kind == "raw")
         """
         if startdepth == 0:
             html_toctree = context["toctree"](**kwargs)
         else:
             # find relevant ancestor page; some pages (search, genindex) won't have one
             ancestorname, toctree_obj = _get_ancestor_pagename(
                 app=app, pagename=pagename, startdepth=startdepth
             )
             if ancestorname is None:
                 raise RuntimeError(
                     "Template requested to generate a TocTree fragment but no suitable "
                     "ancestor found to act as root node. Please report this to theme "
                     "developers."
@@ -522,5 +518,5 @@
     # ... and merge them into a single entity
     result = toctrees[0]
     for resolved_toctree in toctrees[1:]:
         result.extend(resolved_toctree.children)
     return result

tests/sites/test_primary_sidebar_toc/conf.py

@@ -0,0 +1,18 @@
+"""Test conf file."""
+
+# -- Project information -----------------------------------------------------
+
+project = "PyData Tests"
+copyright = "2020, Pydata community"
+author = "Pydata community"
+
+root_doc = "index"
+
+# -- General configuration ---------------------------------------------------
+
+html_theme = "pydata_sphinx_theme"
+
+html_copy_source = True
+html_sourcelink_suffix = ""
+
+html_theme_options = {"navigation_with_keys": False}

tests/sites/test_primary_sidebar_toc/index.rst

@@ -0,0 +1,7 @@
+test-primary-sidebar-toc
+========================
+
+.. toctree::
+
+   page
+   sec/index

tests/sites/test_primary_sidebar_toc/page.rst

@@ -0,0 +1,5 @@
+============
+Page at Root
+============
+
+Some text.

tests/sites/test_primary_sidebar_toc/sec/index.rst

@@ -0,0 +1,10 @@
+===============
+Section at Root
+===============
+
+Some text.
+
+.. toctree::
+   :hidden:
+
+   subpage

tests/sites/test_primary_sidebar_toc/sec/subpage.rst

@@ -0,0 +1,15 @@
+===============
+Page in Section
+===============
+
+Some text.
+
+Subsection
+==========
+
+Some text.
+
+Subsubsection
+-------------
+
+Some text.

tests/test_build.py

@@ -1173,3 +1173,23 @@ def test_role_main_for_search_highlights(sphinx_build_factory):
     """
     sphinx_build = sphinx_build_factory("base").build()
     assert sphinx_build.html_tree("index.html").select_one('[role="main"]')
+
+
+def test_primary_sidebar_hidden_when_empty(sphinx_build_factory) -> None:
+    """Test that the primary sidebar does not show up if it is empty."""
+    sphinx_build = sphinx_build_factory("test_primary_sidebar_toc").build()
+    sidebar_primary = sphinx_build.html_tree("page.html").select(
+        "div.bd-sidebar-primary"
+    )[0]
+    assert "hide-on-wide" in sidebar_primary.attrs["class"]
+
+
+def test_primary_sidebar_exist_when_hidden_toctree(sphinx_build_factory) -> None:
+    """Test that the primary sidebar shows up if there are hidden toctrees."""
+    sphinx_build = sphinx_build_factory("test_primary_sidebar_toc").build()
+    for page in ("sec/index.html", "sec/subpage.html"):
+        sidebar_primary = sphinx_build.html_tree(page).select("div.bd-sidebar-primary")[
+            0
+        ]
+        assert "hide-on-wide" not in sidebar_primary.attrs["class"]
+        assert "Page in Section" in str(sidebar_primary)