linux/poky.git/documentation/README, branch master-next

document how to use :doc: directive

2025-06-20T08:48:15+00:00

Let's specify that we are only expecting "absolute" paths in the docs directive for local document referencing. (From yocto-docs rev: 2729250bf1068814e5106d1e71796e8a505963d7) Signed-off-by: Quentin Schulz Signed-off-by: Antonin Godard Signed-off-by: Richard Purdie

docs: README: specify how to contribute instead of pointing at another file

2025-06-06T21:22:43+00:00

This repository is partially included in another repository: poky. However its README isn't making it, so documentation/README pointing at the README at the root of the git repository would lead the contributor nowhere. Instead, let's include the appropriate information directly in documentation/README which does make it to the poky git repo. (From yocto-docs rev: 0298318cea2947e65754eab97255164e64a862de) Signed-off-by: Quentin Schulz 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

README: add instruction to run Vale on a subset

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

make stylecheck runs Vale on the whole documentation which can be long and reports a lot of errors/warnings. We can run Vale on a subset using the VALEDOCS variable, so update documentation to highlight it. (From yocto-docs rev: 262237f72534c983e178231cb6839ed69709c443) Signed-off-by: Julien Stephan Reviewed-by: Antonin Godard Tested-by: Antonin Godard Signed-off-by: Antonin Godard Signed-off-by: Richard Purdie

documentation/README: refer to doc package requirements

2024-06-16T21:48:18+00:00

Refer to package requirements for building documentation from supported distributions. The simple instructions previously listed no longer work on Ubuntu 24.04, for example. (From yocto-docs rev: c474f211a9a9ab9399627558b801d7546ebcd52b) Signed-off-by: Michael Opdenacker Reviewed-by: Quentin Schulz Signed-off-by: Alexandre Belloni 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: 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: d145e1dc45dc0792c8b8f7e73500b56face1e710) Signed-off-by: Michael Opdenacker Suggested-by: Thomas Petazzoni Signed-off-by: Richard Purdie

manuals: README: update list of manuals

2023-08-30T14:54:59+00:00

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

manuals: simplify references to the BitBake User Manual

2023-03-20T13:16:52+00:00

- Replacing :ref:`bitbake:bitbake-user-manual/...` by :ref:`bitbake-user-manual/...` Adding "bitbake:" as a prefix is not necessary as there is no naming conflict between the YP and the BitBake manuals (all documents are in "bitbake-user-manual/") - Explaining the rules in the README file - When necessary, fixing line length in the modified paragraphs. (From yocto-docs rev: d80b31705450cfb98d217ea44ba2edace2d64095) Signed-off-by: Michael Opdenacker Signed-off-by: Richard Purdie

Documentation/README: formalize guidelines for external link syntax

2022-10-28T14:48:03+00:00

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