godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-04 14:11:02 +03:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #4056 from Calinou/compatibility-notice-fix-meta-description

Browse Source 
Prevent the compatibility notice from being the `meta description`
This commit is contained in:
Rémi Verschelde
2020-09-22 15:15:08 +02:00
committed by GitHub
parent 5a96e5fc34 bdece44b8d
commit b273b78122
2 changed files with 26 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
_static/js/custom.js
View File

@@ -1,3 +1,9 @@
// Set this to `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`.
const inDev = true;
// Handle page scroll and adjust sidebar accordingly.
// Each page has two scrolls: the main scroll, which is moving the content of the page;
@@ -202,6 +208,26 @@ $(document).ready(() => {
registerOnScrollEvent(mediaQuery);
});
if (inDev) {
// Add a compatibility notice using JavaScript so it doesn't end up in the
// automatically generated `meta description` tag.
const url = window.location.href.replace('/latest/', '/stable/');
document.querySelector('div[itemprop="articleBody"]').insertAdjacentHTML('afterbegin', `
<div class="admonition attention">
<p class="first admonition-title">Attention</p>
<p>
You are reading the <code class="docutils literal notranslate"><span class="pre">latest</span></code>
(unstable) version of this documentation, which may document features not available
or compatible with Godot 3.2.x.
</p>
<p class="last">
See <a class="reference" href="${url}">this page</a>
for the stable version of this documentation.
</p>
</div>
`);
}
// Load instant.page to prefetch pages upon hovering. This makes navigation feel
// snappier. The script is dynamically appended as Read the Docs doesn't have
// a way to add scripts with a "module" attribute.

21
conf.py
View File

@@ -52,11 +52,6 @@ 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:
@@ -235,22 +230,6 @@ def godot_get_image_filename_for_language(filename, env):
sphinx.util.i18n.get_image_filename_for_language = godot_get_image_filename_for_language
# 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 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.
See `this page <https://docs.godotengine.org/{locale}/stable/>`__
for the stable version of this documentation.
""".format(
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
# all pages. This is used in index.rst to display the Weblate badge.