linux/poky.git/documentation/Makefile, branch master

The poky repository master branch is no longer being updated.

2025-11-07T13:31:53+00:00

You can either: a) switch to individual clones of bitbake, openembedded-core, meta-yocto and yocto-docs b) use the new bitbake-setup You can find information about either approach in our documentation: https://docs.yoctoproject.org/ Note that "poky" the distro setting is still available in meta-yocto as before and we continue to use and maintain that. Long live Poky! Some further information on the background of this change can be found in: https://lists.openembedded.org/g/openembedded-architecture/message/2179 Signed-off-by: Richard Purdie

Makefile: add a checks rule

2025-08-08T22:41:11+00:00

The checks rule can be run to perform some checks on the docs. For now it only includes running the check-glossaries script. This rule should only run basic checks or should not prevent the user from building the docs in case of failure. This rule can be used in the future to run additional checks on the documentation. (From yocto-docs rev: 1d9a4a52fa9f2e2eb7f282324f85a46b28128fbf) Signed-off-by: Antonin Godard Signed-off-by: Richard Purdie

doc: Makefile: publish pdf and epub versions too

2024-11-12T11:09:51+00:00

Copy the generated files in the special _static directory. Fixes [YOCTO #14357] (From yocto-docs rev: b60c5b86eaef5ddab026837e0952a28c7948bc2d) Signed-off-by: Michael Opdenacker Signed-off-by: Antonin Godard Signed-off-by: Richard Purdie

doc: Makefile: add support for xelatex

2024-11-12T11:09:51+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: bd6265ca323fac547a197bb516dc4a9ef3897508) Signed-off-by: Antonin Godard Signed-off-by: Richard Purdie

doc: Makefile: remove inkscape, replace by rsvg-convert

2024-11-12T11:09:51+00:00

Remove inkscape as it is not part of meta/, and use librsvg so we can ship it in a buildtools tarball for the autobuilder workers. (From yocto-docs rev: 2d92de35e0029bf151c9a0c0e696a127cef14082) Signed-off-by: Antonin Godard Signed-off-by: Richard Purdie

documentation: Makefile: add SPHINXLINTDOCS to specify subset to sphinx-lint

2024-11-07T10:12:24+00:00

make sphinx-lint runs sphinx-lint on the whole documentation which can be long and reports a lot or errors/warnings. Let's add a new SHPINXLINTDOCS variable to allow specifying a subset, just as VALEDOCS does. Keep variable assignment aligned and also use $(SOURCEDIR) by default for SPHINXLINTDOCS and VALEDOCS variables. Also update the README file and fix a typo in Link checking section title. (From yocto-docs rev: 3dfe7b5c746af31de74f67cf88214e5d52bdb65d) Signed-off-by: Julien Stephan Reviewed-by: Antonin Godard Tested-by: Antonin Godard Signed-off-by: Antonin Godard Signed-off-by: Richard Purdie

manuals: add initial sphinx-lint support

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

Makes it possible to catch errors not reported by sphinx, such as idle spaces. After customization, this should be used to enforce our syntax conventions, such as two spaces after a "-" character to introduce a list item. Just run "make sphinx-lint". (From yocto-docs rev: 9e1aeeddca06cb7d65631010ba0eebdcd8ecf9ee) Signed-off-by: Michael Opdenacker Signed-off-by: Richard Purdie

manuals: fix duplicate "stylecheck" target

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

(From yocto-docs rev: f19e4231b1982f97ffd210b76978404fe1f2893b) Signed-off-by: Michael Opdenacker Reviewed-by: Quentin Schulz Signed-off-by: Richard Purdie

manuals: add initial stylechecks with Vale

2024-03-19T15:22:27+00:00

Use the "Vale" (https://vale.sh) tool to perform text style checks Run "make stylecheck" to run the checks. This just checks the text, not the Sphinx syntax style choices. (From yocto-docs rev: 51b1f9a4d5aa02d337b105633de38e18b923a13a) Signed-off-by: Michael Opdenacker Suggested-by: Thomas Petazzoni Signed-off-by: Richard Purdie

documentation: Makefile: remove releases.rst in "make clean"

2024-03-19T15:22:27+00:00

releases.rst is generated by the set_versions.py script (From yocto-docs rev: 4b7773f59bab2d653d07b7e06cd21745b646b604) Signed-off-by: Michael Opdenacker Signed-off-by: Richard Purdie