From 1cefabe0f0a2dd2ca8b6eb83e8e0824b72da941a Mon Sep 17 00:00:00 2001 From: Richard Purdie Date: Wed, 20 Apr 2022 11:33:44 +0100 Subject: 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: f462982ddb6e32052217d44c0c44e8a4df115589) Signed-off-by: Richard Purdie --- documentation/conf.py | 22 ++++++++++++++++++++-- documentation/poky.yaml | 2 ++ 2 files changed, 22 insertions(+), 2 deletions(-) diff --git a/documentation/conf.py b/documentation/conf.py index e7c2e502f3..d2478ae00b 100644 --- a/documentation/conf.py +++ b/documentation/conf.py @@ -15,9 +15,27 @@ import os import sys import datetime +try: + import yaml +except ImportError: + sys.stderr.write("The Yocto Project Sphinx documentation requires PyYAML.\ + \nPlease make sure to install pyyaml python package.\n") + sys.exit(1) -current_version = "3.3.6" -bitbake_version = "1.50" +# current_version = "dev" +# bitbake_version = "" # Leave empty for development branch +# Obtain versions from poky.yaml instead +with open("poky.yaml") as data: + buff = data.read() + subst_vars = yaml.safe_load(buff) + if "DOCCONF_VERSION" not in subst_vars: + sys.stderr.write("Please set DOCCONF_VERSION in poky.yaml") + sys.exit(1) + current_version = subst_vars["DOCCONF_VERSION"] + if "BITBAKE_SERIES" not in subst_vars: + sys.stderr.write("Please set BITBAKE_SERIES in poky.yaml") + sys.exit(1) + bitbake_version = subst_vars["BITBAKE_SERIES"] # String used in sidebar version = 'Version: ' + current_version diff --git a/documentation/poky.yaml b/documentation/poky.yaml index 769a981b68..d57b4d7101 100644 --- a/documentation/poky.yaml +++ b/documentation/poky.yaml @@ -6,6 +6,8 @@ DISTRO_NAME_NO_CAP_LTS : "gatesgarth" YOCTO_DOC_VERSION : "3.3.6" YOCTO_DOC_VERSION_MINUS_ONE : "3.2.4" DISTRO_REL_TAG : "yocto-3.3.6" +DOCCONF_VERSION : "3.3.6" +BITBAKE_SERIES : "1.50" POKYVERSION : "25.0.6" YOCTO_POKY : "poky-&DISTRO_NAME_NO_CAP;-&POKYVERSION;" YOCTO_DL_URL : "https://downloads.yoctoproject.org" -- cgit v1.2.3-54-g00ecf