summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorRichard Purdie <richard.purdie@linuxfoundation.org>2022-04-20 11:33:44 +0100
committerRichard Purdie <richard.purdie@linuxfoundation.org>2022-04-20 17:26:55 +0100
commitb6ce93d565cec4eca94da05f3b9bf7f6bf115b75 (patch)
tree3d6df0f15ddcfe8f3ef48d1eca0d1e953085da96 /documentation
parentce50594d709f473fbad30e187565531af6714aaa (diff)
downloadpoky-b6ce93d565cec4eca94da05f3b9bf7f6bf115b75.tar.gz
conf.py/poky.yaml: Move version information to poky.yaml and read in conf.py
Merge in the changes from master allowing conf.py to use information from poky.yaml. This allows the head version mapped to X.999 on the website to have the version information displayed clearly and correctly. (From yocto-docs rev: df813c6d6c1477519f13699987215c8d9bc0a7bf) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/conf.py22
-rw-r--r--documentation/poky.yaml2
2 files changed, 22 insertions, 2 deletions
diff --git a/documentation/conf.py b/documentation/conf.py
index 4df8f55d17..df67a5cdf2 100644
--- a/documentation/conf.py
+++ b/documentation/conf.py
@@ -15,9 +15,27 @@
15import os 15import os
16import sys 16import sys
17import datetime 17import datetime
18try:
19 import yaml
20except ImportError:
21 sys.stderr.write("The Yocto Project Sphinx documentation requires PyYAML.\
22 \nPlease make sure to install pyyaml python package.\n")
23 sys.exit(1)
18 24
19current_version = "3.1.15" 25# current_version = "dev"
20bitbake_version = "1.46" 26# bitbake_version = "" # Leave empty for development branch
27# Obtain versions from poky.yaml instead
28with open("poky.yaml") as data:
29 buff = data.read()
30 subst_vars = yaml.safe_load(buff)
31 if "DOCCONF_VERSION" not in subst_vars:
32 sys.stderr.write("Please set DOCCONF_VERSION in poky.yaml")
33 sys.exit(1)
34 current_version = subst_vars["DOCCONF_VERSION"]
35 if "BITBAKE_SERIES" not in subst_vars:
36 sys.stderr.write("Please set BITBAKE_SERIES in poky.yaml")
37 sys.exit(1)
38 bitbake_version = subst_vars["BITBAKE_SERIES"]
21 39
22# String used in sidebar 40# String used in sidebar
23version = 'Version: ' + current_version 41version = 'Version: ' + current_version
diff --git a/documentation/poky.yaml b/documentation/poky.yaml
index e0f8166f72..edc23f8aa7 100644
--- a/documentation/poky.yaml
+++ b/documentation/poky.yaml
@@ -5,6 +5,8 @@ DISTRO_NAME_NO_CAP_MINUS_ONE : "zeus"
5YOCTO_DOC_VERSION : "3.1.15" 5YOCTO_DOC_VERSION : "3.1.15"
6YOCTO_DOC_VERSION_MINUS_ONE : "3.0.4" 6YOCTO_DOC_VERSION_MINUS_ONE : "3.0.4"
7DISTRO_REL_TAG : "yocto-3.1.15" 7DISTRO_REL_TAG : "yocto-3.1.15"
8DOCCONF_VERSION : "3.1.15"
9BITBAKE_SERIES : "1.46"
8POKYVERSION : "23.0.15" 10POKYVERSION : "23.0.15"
9YOCTO_POKY : "poky-&DISTRO_NAME_NO_CAP;-&POKYVERSION;" 11YOCTO_POKY : "poky-&DISTRO_NAME_NO_CAP;-&POKYVERSION;"
10YOCTO_DL_URL : "https://downloads.yoctoproject.org" 12YOCTO_DL_URL : "https://downloads.yoctoproject.org"