[PATCH] documentation: conf.py: add knob for loading appropriate objects.inv

[PATCH] documentation: conf.py: add knob for loading appropriate objects.inv

[Quentin Schulz]

From: Quentin Schulz <quentin.schulz@theobroma-systems.com>

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>
Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
---
 documentation/conf.py | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/documentation/conf.py b/documentation/conf.py
index 8e0847938..1bea18032 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 ..."
-- 
2.33.1

Re: [docs] [PATCH] documentation: conf.py: add knob for loading appropriate objects.inv

[Michael Opdenacker]

Hi Quentin,

On 12/3/21 11:33 AM, Quentin Schulz wrote:
> From: Quentin Schulz <quentin.schulz@theobroma-systems.com>
>
> 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>
> Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
> ---
>  documentation/conf.py | 3 ++-
>  1 file changed, 2 insertions(+), 1 deletion(-)
>
> diff --git a/documentation/conf.py b/documentation/conf.py
> index 8e0847938..1bea18032 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 ..."

Excellent idea ! Thanks for the patch.
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
... and merged into "master-next".

I'll take care of adapting and applying it on the currently supported
release branches (dunfell, hardknott, honister). I'll do that directly
in the branches, but let me know if I should submit patches first.
Thanks again
Michael.

-- 
Michael Opdenacker, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com

Re: [docs] [PATCH] documentation: conf.py: add knob for loading appropriate objects.inv

[Michael Opdenacker]

On 12/8/21 4:47 PM, Michael Opdenacker wrote:
>
> I'll take care of adapting and applying it on the currently supported
> release branches (dunfell, hardknott, honister). I'll do that directly
> in the branches, but let me know if I should submit patches first.
> Thanks again
> Michael.

Done. Dunfell was actually correct, hardcoding the right Bitbake
version. Hardknott and Honister were indeed using the master version of
Bitbake objects.
Thanks again
Michael.

-- 
Michael Opdenacker, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com