summaryrefslogtreecommitdiffstats
path: root/documentation/conf.py
diff options
context:
space:
mode:
authorQuentin Schulz <quentin.schulz@theobroma-systems.com>2021-12-03 11:33:15 +0100
committerRichard Purdie <richard.purdie@linuxfoundation.org>2021-12-13 23:31:34 +0000
commitc7c5fc879c37aef44a5ab9719a2449759db07690 (patch)
tree2a264fc0cf64fabd6641ad80cfdca0a6e22ff3bf /documentation/conf.py
parente6f8c401aa55ec8778afbb342457d01050aeaddf (diff)
downloadpoky-c7c5fc879c37aef44a5ab9719a2449759db07690.tar.gz
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 <foss+yocto@0leil.net> (From yocto-docs rev: 457a591a46c57519046f9e3f8bffd632bb2275ea) Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/conf.py')
-rw-r--r--documentation/conf.py3
1 files changed, 2 insertions, 1 deletions
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
17import datetime 17import datetime
18 18
19current_version = "dev" 19current_version = "dev"
20bitbake_version = "" # Leave empty for development branch
20 21
21# String used in sidebar 22# String used in sidebar
22version = 'Version: ' + current_version 23version = 'Version: ' + current_version
@@ -90,7 +91,7 @@ extlinks = {
90 91
91# Intersphinx config to use cross reference with Bitbake user manual 92# Intersphinx config to use cross reference with Bitbake user manual
92intersphinx_mapping = { 93intersphinx_mapping = {
93 'bitbake': ('https://docs.yoctoproject.org/bitbake/', None) 94 'bitbake': ('https://docs.yoctoproject.org/bitbake/' + bitbake_version, None)
94} 95}
95 96
96# Suppress "WARNING: unknown mimetype for ..." 97# Suppress "WARNING: unknown mimetype for ..."