linux/poky.git/documentation/README, branch yocto-4.0.24

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

2024-11-11T14:19:19+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: ae46746897361d4177f3c4284f46753e3aa8c3c3) 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-11T14:19:19+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: 038cc992af79718787a70dd620eb195c84a847dd) 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

manuals: add initial sphinx-lint support

2024-04-19T11:50:39+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: a735549a764f7cfebdc7534761b4d75dc523371a) Signed-off-by: Michael Opdenacker Signed-off-by: Steve Sakoman

manuals: add initial stylechecks with Vale

2024-04-05T14:23:59+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: e3e4ba2aa963d4d178c4e9e842e66f4ee4bd3736) Signed-off-by: Michael Opdenacker Suggested-by: Thomas Petazzoni Signed-off-by: Steve Sakoman

documentation/README: align with master

2023-09-23T15:26:16+00:00

(From yocto-docs rev: 8638eadda09e932534eb6bb345b4d0299974b219) Signed-off-by: Michael Opdenacker Signed-off-by: Steve Sakoman

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

documentation/README: how to upgrade Sphinx packages

2022-03-04T09:39:37+00:00

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

documentation/README: trivial typo fix

2022-01-07T11:12:06+00:00

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

manuals: start of documentation standards document

2021-11-07T10:44:52+00:00

This first version specifies how to create consistent SGV graphics (From yocto-docs rev: 370b9e34e9092c9eed22df2e8b2d0bb979487e5c) Signed-off-by: Michael Opdenacker Signed-off-by: Richard Purdie

Makefile: allow epub and latexpdf outputs to use diagrams from SVG sources

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

html output is great when directly using SVG epub output has to use exported PNG because of issues using SVG directly latexpdf output cannot use SVG, it needs exported PDF instead This adds rules to generate PNG and PDF formats from new SVG sources. Newly added diagrams have be stored in svg/ subdirectories so that PNG and PDF files generated from SVG can be "gitignored" without ignoring the original PNG diagrams that have no SVG source. Note: had to remove the dependency to "Makefile" in the final "catch-all" target, otherwise it was also catching the SVG to PNG and SVG to PDF targets. (From yocto-docs rev: cd9bbd41d323bc124057396f142010509c65bbaf) Signed-off-by: Michael Opdenacker Reviewed-by: Nicolas Dechesne Signed-off-by: Quentin Schulz Signed-off-by: Richard Purdie