Merge pull request #197 from f5devcentral/banner-message

Enable Ability to Add Banner Message
f5devcentral · Jul 27, 2024 · 96a0e6d · 96a0e6d
2 parents 0db0451 + aaff10b
commit 96a0e6d
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 1 deletion.
diff --git a/f5_sphinx_theme/__init__.py b/f5_sphinx_theme/__init__.py
@@ -16,7 +16,7 @@
 from os import path
 
 
-__version__ = "2.6.1"
+__version__ = "2.7.0"
 
 
 def get_html_theme_path():

diff --git a/f5_sphinx_theme/layout.html b/f5_sphinx_theme/layout.html
@@ -112,6 +112,12 @@ <h5>{{ project }} {{ version }} </h5>
 
       <article class="docs-container site-article-inner">
 
+        {%- if theme_banner_msg %}
+        <div class="clouddocs-banner">
+          <p>{{ theme_banner_msg }}</p>
+        </div>
+        {%- endif %}
+
         {%- block breadcrumb %}
         {% include "breadcrumb.html" %}
         {% endblock %}

diff --git a/f5_sphinx_theme/static/css/f5-theme.css b/f5_sphinx_theme/static/css/f5-theme.css
@@ -1368,3 +1368,11 @@ This section here is the css styling for the dropdown menu
 .dropdown:hover .dropbtn {
   background-color: #002e63;
 }
+
+.clouddocs-banner {
+  text-align: center;
+  width: 100%;
+  background-color: #ffcc00;
+  color: black;
+  font-weight: bold;
+}
diff --git a/f5_sphinx_theme/theme.conf b/f5_sphinx_theme/theme.conf
@@ -18,3 +18,4 @@ sidebar_toc_maxdepth =
 hide_right_menu =
 show_project = True
 display_last_updated =
+banner_msg =