|
|
@@ -52,6 +52,11 @@ version = os.getenv("READTHEDOCS_VERSION", "latest")
|
|
|
# The full version, including alpha/beta/rc tags
|
|
|
release = version
|
|
|
|
|
|
+# Set this True when the `latest` branch is significantly incompatible with the
|
|
|
+# current `stable` branch, which can lead to confusion for users that land on
|
|
|
+# `latest` instead of `stable`.
|
|
|
+in_dev = True
|
|
|
+
|
|
|
# Parse Sphinx tags passed from RTD via environment
|
|
|
env_tags = os.getenv("SPHINX_TAGS")
|
|
|
if env_tags is not None:
|
|
|
@@ -233,8 +238,9 @@ sphinx.util.i18n.get_image_filename_for_language = godot_get_image_filename_for_
|
|
|
# Read the Docs adds a note at the top of the page when reading documentation
|
|
|
# for an old stable version, but not when reading the latest unstable version.
|
|
|
# We want to add a warning note as the `latest` documentation may not always
|
|
|
-# apply to Godot 3.2.x.
|
|
|
-rst_prolog = """
|
|
|
+# apply to the current `stable` version.
|
|
|
+if in_dev:
|
|
|
+ rst_prolog = """
|
|
|
.. attention::
|
|
|
You are reading the ``latest`` (unstable) version of this documentation,
|
|
|
which may document features not available or compatible with Godot 3.2.x.
|
|
|
@@ -242,8 +248,8 @@ rst_prolog = """
|
|
|
See `this page <https://docs.godotengine.org/{locale}/stable/>`__
|
|
|
for the stable version of this documentation.
|
|
|
""".format(
|
|
|
- locale=language,
|
|
|
-)
|
|
|
+ locale=language,
|
|
|
+ )
|
|
|
|
|
|
# Couldn't find a way to retrieve variables nor do advanced string
|
|
|
# concat from reST, so had to hardcode this in the "epilog" added to
|
Rémi Verschelde