From 054b9f4d332327f9c8ffd5b2ab76204822c264b2 Mon Sep 17 00:00:00 2001
From: patrick96 <p.ziegler96@gmail.com>
Date: Sun, 22 Oct 2023 21:21:16 +0200
Subject: [PATCH] docs: Add banner for 'latest' version

---
 doc/_templates/layout.html | 26 ++++++++++++++++++++++++++
 doc/conf.py                |  4 ++++
 2 files changed, 30 insertions(+)
 create mode 100644 doc/_templates/layout.html

diff --git a/doc/_templates/layout.html b/doc/_templates/layout.html
new file mode 100644
index 00000000..12022e98
--- /dev/null
+++ b/doc/_templates/layout.html
@@ -0,0 +1,26 @@
+{% extends "!layout.html" -%}
+{# Refer to https://github.com/readthedocs/sphinx_rtd_theme/blob/master/sphinx_rtd_theme/layout.html #}
+
+{%- block document %}
+{#
+  Adds a warning message on the 'latest' version.
+  The warning is only added on readthedocs, if the version is 'latest'.
+  For the 'dev' folder, no warning is shown since the 'latest' version is
+  usually the most up-to-date.
+#}
+{% if READTHEDOCS and polybar_is_latest and not pagename.startswith('dev/') %}
+<div class="admonition important">
+  <p class="admonition-title">Development Version</p>
+  <p>
+  This is the <code class="docutils literal notranslate"><span class="pre">latest</span></code>
+  (unstable) version of this documentation, which may document features
+  not available in or compatible with released stable versions of polybar.
+  </p>
+  <p>
+  See the <a href="https://polybar.readthedocs.io/{{ pagename }}.html">stable version</a> of this documentation page instead.
+  </p>
+</div>
+{% endif %}
+
+{{ super() }}
+{%- endblock %}
diff --git a/doc/conf.py b/doc/conf.py
index b780f82d..a82c0e03 100644
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -149,6 +149,10 @@ extlinks_detect_hardcoded_links = True
 #
 html_theme_options = {}
 
+html_context = {
+        'polybar_is_latest': version == 'latest',
+}
+
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #