Prepend "(DEV)" to HTML titles if build locally/not on RTD

Sightwalker · Apr 28, 2020 · 0b6d26e · 0b6d26e
1 parent 3c79f3e
commit 0b6d26e
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 0 deletions.
diff --git a/_templates/layout.html b/_templates/layout.html
@@ -12,3 +12,7 @@
   {% endif -%}
   {{ super() }}
 {% endblock -%}
+
+{% block htmltitle -%}
+<title>{{ godot_title_prefix }}{{ title|striptags|e }}{{ titlesuffix }}</title>
+{% endblock -%}
diff --git a/conf.py b/conf.py
@@ -126,6 +126,9 @@
     "godot_docs_suffix": ".html",
     "godot_default_lang": "en",
     "godot_canonical_version": "stable",
+    # Distinguish local development website from production website.
+    # This prevents people from looking for changes on the production website after making local changes :)
+    "godot_title_prefix": "" if on_rtd else "(DEV) ",
 }
 
 html_logo = "img/docs_logo.png"