linux/poky.git/documentation/conf.py, branch kirkstone-4.0.7

SPDX and CVE documentation updates

2022-12-07T15:04:15+00:00

Backporting from master the ones that are applicable to kirkstone. (From yocto-docs rev: c10d65ef3bbdf4fe3abc03e3aef3d4ca8c2ad87f) Signed-off-by: Michael Opdenacker Signed-off-by: Mikko Rapeli Signed-off-by: Richard Purdie

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

2022-04-25T14:22:12+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

conf.py: use PNG first in EPUB output

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

SVG directly included in EPUB output has multiple issues, in particular font size and alignment ones (tested on two EPUB readers). Instead, using PNG, generated from SVG when available as the primary format for images. GIF and JPEG are fine too. (From yocto-docs rev: ff3876ca4910cf61bc25bfeb07e65ad6f6a93b48) Signed-off-by: Michael Opdenacker Reviewed-by: Nicolas Dechesne Signed-off-by: Quentin Schulz Signed-off-by: Richard Purdie

manuals: mention license information in footer

2021-08-10T10:29:46+00:00

Previously, the license for the manuals was only stated in the SPDX headers at the beginning of source files (From yocto-docs rev: cef60f23d5601a18d7ba7e894af2aa459fb2efb8) Signed-off-by: Michael Opdenacker Signed-off-by: Richard Purdie

manuals: fix epub export warnings

2021-06-14T21:45:33+00:00

Needed now that warnings are turned into errors (From yocto-docs rev: 3f99cff8c6c672967eb09f6950d16ed30260ca68) Signed-off-by: Michael Opdenacker Signed-off-by: Richard Purdie

documentation: Prevent building documentation with an outdated version of sphinx

2021-01-20T00:53:53+00:00

Building with a outdated version of Sphinx print warnings that does not appear on up-to-date sphinx. This patch prevent building the documentation with any version older than 3.1 (First version to build without warnings in my tests) See threads "documentation: Add a simple Sphinx extension to check its version" https://lists.yoctoproject.org/g/docs/topic/patch_documentation_add_a/79919516 and "toaster-manual: Fix a warning related to the code-block directive" https://lists.yoctoproject.org/g/docs/topic/patch_toaster_manual_fix_a/79656195 (From yocto-docs rev: 4de0f3dd4d5df0a0700f704a599bb41726d15a5f) Signed-off-by: Yoann Congal Signed-off-by: Richard Purdie