From c7c5fc879c37aef44a5ab9719a2449759db07690 Mon Sep 17 00:00:00 2001 From: Quentin Schulz Date: Fri, 3 Dec 2021 11:33:15 +0100 Subject: documentation: conf.py: add knob for loading appropriate objects.inv Yocto Project releases use a specific Bitbake release. Currently the bitbake: mapping is pointing to the current master version of Bitbake documentation. This is an issue if some links disappear over time and someone is still building old documentation (which is the case on the YP autobuilder for example). Also, the documentation at the current master version of Bitbake might not be correct for the Yocto Project version associated with the doc the user is currently looking at, potentially causing confusion. In master branch, nothing needs to be done. For release branches, the bitbake_version variable needs to be set accordingly. See https://wiki.yoctoproject.org/wiki/Releases for the mapping. Cc: Quentin Schulz (From yocto-docs rev: 457a591a46c57519046f9e3f8bffd632bb2275ea) Signed-off-by: Quentin Schulz Reviewed-by: Michael Opdenacker Signed-off-by: Richard Purdie --- documentation/conf.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) (limited to 'documentation/conf.py') diff --git a/documentation/conf.py b/documentation/conf.py index 8e0847938e..1bea180325 100644 --- a/documentation/conf.py +++ b/documentation/conf.py @@ -17,6 +17,7 @@ import sys import datetime current_version = "dev" +bitbake_version = "" # Leave empty for development branch # String used in sidebar version = 'Version: ' + current_version @@ -90,7 +91,7 @@ extlinks = { # Intersphinx config to use cross reference with Bitbake user manual intersphinx_mapping = { - 'bitbake': ('https://docs.yoctoproject.org/bitbake/', None) + 'bitbake': ('https://docs.yoctoproject.org/bitbake/' + bitbake_version, None) } # Suppress "WARNING: unknown mimetype for ..." -- cgit v1.2.3-54-g00ecf