summaryrefslogtreecommitdiff
path: root/docs/conf.py
diff options
context:
space:
mode:
authorJim Mussared <jim.mussared@gmail.com>2022-10-18 16:24:33 +1100
committerDamien George <damien@micropython.org>2022-10-26 16:23:20 +1100
commit64af916c111b61bce82c00f356a6b1cb81946d87 (patch)
tree1cb3ee3331cee9967b74fc519a49067732528676 /docs/conf.py
parentd75c7e822cbfe7014fede1420f996a0af04bb13c (diff)
docs/templates/layout.html: Indicate latest vs release docs.
When looking at latest (the default for docs.micropython.org), make it clear that this isn't the release version. - Changes the version in the top-left to "latest". - Adds a message to the top of each page to explain. For future release versions, add a short message to link to the latest version. This work was funded through GitHub Sponsors. Signed-off-by: Jim Mussared <jim.mussared@gmail.com>
Diffstat (limited to 'docs/conf.py')
-rwxr-xr-xdocs/conf.py3
1 files changed, 2 insertions, 1 deletions
diff --git a/docs/conf.py b/docs/conf.py
index 5533bf019..ce5c03756 100755
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -33,6 +33,7 @@ html_context = {
'downloads':[
('PDF', url_pattern % micropy_version + '/micropython-docs.pdf'),
],
+ 'is_release': micropy_version != 'latest',
}
@@ -74,7 +75,7 @@ copyright = '- The MicroPython Documentation is Copyright © 2014-2022, Damien P
#
# We don't follow "The short X.Y version" vs "The full version, including alpha/beta/rc tags"
# breakdown, so use the same version identifier for both to avoid confusion.
-version = release = '1.19.1'
+version = release = micropy_version
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.