moved latest warning banner logic to conf.py (SciTools#5508)

tkknight · Oct 26, 2023 · cc52dca · cc52dca
1 parent a65f391
commit cc52dca
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 20 deletions.
diff --git a/docs/src/_templates/layout.html b/docs/src/_templates/layout.html
diff --git a/docs/src/conf.py b/docs/src/conf.py
@@ -331,6 +331,16 @@ def _dotv(version):
     },
 }
 
+# if we are building via Read The Docs and it is the latest (not stable)
+if on_rtd and rtd_version == "latest":
+    html_theme_options[
+        "announcement"
+    ] = f"""
+        You are viewing the <b>latest</b> unreleased documentation
+        <strong>{version}</strong>. You can switch to a
+        <a href="https://scitools-iris.readthedocs.io/en/stable/">stable</a>
+        version."""
+
 rev_parse = run(["git", "rev-parse", "--short", "HEAD"], capture_output=True)
 commit_sha = rev_parse.stdout.decode().strip()