Do not show announcement banner if announcement contents are empty (#…

…1703) * Do not show announcement banner if announcement contents are empty Also add documentation about updating and removing announcement banners. * dedent * Apply suggestions from code review --------- Co-authored-by: Daniel McCloy <[email protected]>
pydata · Feb 12, 2024 · 7de2c04 · 7de2c04
1 parent 355d612
commit 7de2c04
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 0 deletions.
diff --git a/docs/user_guide/announcements.rst b/docs/user_guide/announcements.rst
@@ -41,6 +41,15 @@ For example, the following configuration tells the theme to load the ``custom-te
       "announcement": "https://github.com/pydata/pydata-sphinx-theme/raw/main/docs/_templates/custom-template.html",
    }
 
+Update or remove announcement banner
+------------------------------------
+
+To update or remove the announcement banner, you can change the value of
+``html_theme_options["announcement"]`` in your ``conf.py`` or you can edit the
+contents of the ``custom-template.html`` file directly. For example, if you have a
+temporary announcement that you want to remove without rebuilding your
+documentation pages, you can use an empty ``custom-template.html`` file and the
+banner will be hidden.
 
 .. _version-warning-banners:
 

diff --git a/src/pydata_sphinx_theme/theme/pydata_sphinx_theme/sections/announcement.html b/src/pydata_sphinx_theme/theme/pydata_sphinx_theme/sections/announcement.html
@@ -7,6 +7,10 @@
 fetch("{{ theme_announcement }}")
   .then(res => {return res.text();})
   .then(data => {
+    if (data.length === 0) {
+      console.log("[PST]: Empty announcement at: {{ theme_announcement }}");
+      return;
+    }
     div = document.querySelector(".bd-header-announcement");
     div.classList.add(...{{ header_classes | tojson }});
     div.innerHTML = `<div class="bd-header-announcement__content">${data}</div>`;