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

Add favicon for the documentation html

2025-02-21T14:34:58+00:00

Import the favicon from https://www.yoctoproject.org/, convert it to 16x16 (as per the Sphinx documentation) to make a 1291B image of the Yocto logo. (From yocto-docs rev: 2631fc95a6528a5c6f0048087c102e0649afc551) Signed-off-by: Antonin Godard (cherry picked from commit e3ee43e6d70685a2404aae2d60557a42879b0bb1) Signed-off-by: Antonin Godard Signed-off-by: Steve Sakoman

conf.py: add a bitbake_git extlink

2024-11-26T13:37:10+00:00

To make references to the bitbake repo, add an extlink for it and use it in the docs with ":bitbake_git:`lib/bb/utils.py `". Reviewed-by: Quentin Schulz (From yocto-docs rev: 5efb5f678278276aebd6809ab785dcea8c732de3) Signed-off-by: Antonin Godard (cherry picked from commit 8bf3c656ec54a582c75ca7c135121a15f8e4f631) Signed-off-by: Antonin Godard Signed-off-by: Steve Sakoman

doc: Makefile: add support for xelatex

2024-11-26T13:37:10+00:00

This patch makes the "latexpdf" target compile the documentation with xelatex instead of the default pdflatex engine. The reason behind this is stated in [YOCTO #14357]: pdflatex does not support compiling foreign characters, so we need to resort to another engine, here xelatex. It also increases the texmf config buf_size to 10000000 to avoid a compilation error. (From yocto-docs rev: 9a297c65942a52d6165378d6792d5e0788b492ba) Signed-off-by: Antonin Godard (cherry picked from commit 93848842b3ad8aa6b9c9f46d60f2c2ad396c6971) Signed-off-by: Antonin Godard Signed-off-by: Steve Sakoman

conf.py: rename :cve: role to :cve_nist:

2024-11-11T17:16:26+00:00

Newer versions of Sphinx already define a :cve: role that points to cve.org, instead of the role we defined in conf.py that points to nvd.nist.gov. Rename our role to :cve_nist: to avoid warnings (treated as errors). This is also backwards compatible, meaning we can build the doc with an older Sphinx if needed. The file were automatically replaced with following command: find . -name '*.rst' -exec sed -i 's/:cve:/:cve_nist:/g' {} \+ Suggested-By: Quentin Schulz Reviewed-by: Quentin Schulz (From yocto-docs rev: 1e5e574a6cdb6b086da2c5a981446b522e80cf2d) Signed-off-by: Antonin Godard (cherry picked from commit 15fa3b7e85dde50d7236c1738ad607531cc654b8) Signed-off-by: Antonin Godard Signed-off-by: Steve Sakoman

docs: conf.py: properly escape backslashes for latex_elements

2024-04-08T13:36:38+00:00

There are some syntax warnings returned by Python: """ yocto-docs/documentation/conf.py:162: SyntaxWarning: invalid escape sequence '\P' 'passoptionstopackages': '\PassOptionsToPackage{bookmarksdepth=5}{hyperref}', yocto-docs/documentation/conf.py:163: SyntaxWarning: invalid escape sequence '\s' 'preamble': '\setcounter{tocdepth}{2}', """ Backslashes must be doubled in Python string literals to avoid interpretation as escape sequence, c.f. https://www.sphinx-doc.org/en/master/latex.html#module-latex. Cc: Quentin Schulz (From yocto-docs rev: a78d9bde7f90f860aa969b7d8e47350de9106183) Signed-off-by: Quentin Schulz Reviewed-by: Michael Opdenacker Signed-off-by: Richard Purdie

conf.py: add macro for Mitre CVE links

2023-05-26T16:32:51+00:00

Useful for CVEs that are not found (yet) on https://nvd.nist.gov/ (From yocto-docs rev: bd9add8a0e62465429cf62c314aaa766b7f6f544) Signed-off-by: Michael Opdenacker Signed-off-by: Richard Purdie

manuals: add shortcut for Wikipedia links

2022-11-07T21:31:32+00:00

(From yocto-docs rev: 47101c15cce156ab71683cac1c42ab94f43bdbee) 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