linux/poky.git/documentation/conf.py, branch yocto-4.1.2

backport SPDX documentation and vulnerability improvements

2022-11-29T10:52:16+00:00

(From yocto-docs rev: c87d0388caba56490c32e27911b10c926ca02ea9) Signed-off-by: Michael Opdenacker Signed-off-by: Richard Purdie

docs: conf.py: update yocto_git base URL

2022-08-12T22:11:28+00:00

The URLs are actually redirected from https://git.yoctoproject.org/cgit/cgit.cgi to https://git.yoctoproject.org so let's save the user a redirection and use the most up-to-date URL. Cc: Quentin Schulz (From yocto-docs rev: cb6dcfe92638be6c1dee647daf00cfc2191694b2) Signed-off-by: Quentin Schulz Reviewed-by: Michael Opdenacker Signed-off-by: Richard Purdie

Revert "docs: conf.py: fix cve extlinks caption for sphinx <4.0"

2022-07-06T09:33:25+00:00

This reverts commit c9922076f5c1285d9cfd6aff8ce5b6635d88222f. Since the minimum version required to build the docs has been bumped in the previous commit to 4.0, this commit is not required. Moreover, since Sphinx 5.0 triggers a warning when extlinks captions are not using %s substitution and Sphinx 6.0 will fail to build without the substitution characters, this revert is now required to be able to build the docs. Cc: Quentin Schulz (From yocto-docs rev: 9db804f5c5231bee50a99730a576bff7559f9631) Signed-off-by: Quentin Schulz Signed-off-by: Richard Purdie

docs: conf.py: bump minimum Sphinx version requirement

2022-07-06T09:33:25+00:00

extlinks captions support using %s substitution but only from sphinx 4.0 onwards. Anything before does not support the %s substitution. However, this will be a requirement in sphinx 6.0 and later, and sphinx 5.0 already shows a warning telling us that. Since the build is made with -W flag which fails it if any warning is printed, a fix is required. Sphinx 4.0.0 was released two years ago. Unfortunately, Debian packages are out-of-date and only the latest Ubuntu has recent enough packages. Therefore, pip installation should be recommended now instead and the minimum version for building the docs bumped to 4.0. Cc: Quentin Schulz (From yocto-docs rev: ab45a7a40484a2d8e604cb45549037c526ec61cb) Signed-off-by: Quentin Schulz Signed-off-by: Richard Purdie

manuals: fix name capitalization issues

2022-05-10T11:52:34+00:00

- Using "BitBake" instead of "Bitbake" or "bitbake", aligning with the title of the "BitBake User Manual". - Using "OpenEmbedded" instead of "Openembedded" - Using "Python" instead of "python" (From yocto-docs rev: 0b893e2a15aefedd7100445fc9d7eeed07b6afc6) Signed-off-by: Michael Opdenacker Signed-off-by: Richard Purdie

docs: conf.py: fix cve extlinks caption for sphinx <4.0

2022-04-25T14:14:09+00:00

extlinks captions support using %s substitution but only from sphinx 4.0 onwards. c.f. https://www.sphinx-doc.org/en/master/usage/extensions/extlinks.html#confval-extlinks Weirdly enough, on older sphinx versions, the caption is just a prefix to the actual text passed to the extlink. Therefore, in that specific case, CVE- or CVE-%s are identical in meaning for sphinx >=4.0 and since only CVE- caption works on sphinx <4.0, let's go with CVE- caption prefix. Fixes: b311070d866cf "manuals: add 3.4 and 3.4.1 release notes after migration information" Cc: Quentin Schulz (From yocto-docs rev: c9922076f5c1285d9cfd6aff8ce5b6635d88222f) Signed-off-by: Quentin Schulz Signed-off-by: Richard Purdie

conf.py/set_versions/poky.yaml: Set version in conf.py from poky.yaml

2022-03-23T12:08:56+00:00

Allow conf.py to read the versions it needs from poky.yaml and have set_versions.py write this out. This means we don't have to change as many files when making new releases. (From yocto-docs rev: bfe74c67f327f0c6445cb4129ee0c32db022b95a) Signed-off-by: Richard Purdie

manuals: add 3.4 and 3.4.1 release notes after migration information

2022-02-18T17:58:02+00:00

Only done for release 3.4 and 3.4.1 so far. Release notes are kept under the migration-guides/ directory for the moment, for easier reviewing. (From yocto-docs rev: b311070d866cf4ab51c72ff3ac7bc41ea3e932cb) Signed-off-by: Michael Opdenacker Signed-off-by: Richard Purdie

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

2021-12-13T23:31:34+00:00

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

manuals: introduce 'yocto_sstate' extlink

2021-10-08T21:01:24+00:00

(From yocto-docs rev: f428c8d3bb12bfdb2b2afb03e0e6b80e28fd0e62) Signed-off-by: Michael Opdenacker Signed-off-by: Richard Purdie