linux/poky.git/documentation/README, branch styhead

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

2024-11-11T17:16:26+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: 46a9480f4904d00dbce103be52cf7dd4d14c27b9) Signed-off-by: Julien Stephan Reviewed-by: Antonin Godard Tested-by: Antonin Godard Signed-off-by: Antonin Godard (cherry picked from commit 3dfe7b5c746af31de74f67cf88214e5d52bdb65d) Signed-off-by: Antonin Godard Signed-off-by: Steve Sakoman

README: add instruction to run Vale on a subset

2024-11-11T17:16:26+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: ba8642cd423b59ecff5e74a0ed0469deef9f5d18) Signed-off-by: Julien Stephan Reviewed-by: Antonin Godard Tested-by: Antonin Godard Signed-off-by: Antonin Godard (cherry picked from commit 262237f72534c983e178231cb6839ed69709c443) Signed-off-by: Antonin Godard Signed-off-by: Steve Sakoman

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

docs: README: add TeX font package required for building PDF

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

The fncychap.sty font needs to be installed on the host in order to be able to build the PDF version of the docs, so let's mention it in the README. Cc: Quentin Schulz (From yocto-docs rev: 97fb41801fb7ac1439f8af03d2da2fb2f171a7e6) Signed-off-by: Quentin Schulz Reviewed-by: Michael Opdenacker Signed-off-by: Richard Purdie

documentation/README: correct heading styles actually used in the YP manuals

2022-03-16T14:25:01+00:00

Sphinx seems to offer flexibility in heading styles definitions, but the new text matches the way subsubsections and subsubsubsections are defined in the current manuals. Note that it's not possible to mix different definitions, for example by using "~~~~" and "^^^^" for subsubsections in different places. (From yocto-docs rev: 89a9af58adaa4cf4708d0383655b992f8c7239e2) Signed-off-by: Michael Opdenacker Signed-off-by: Richard Purdie