linux/poky.git/documentation/Makefile, branch halstead/hashclient

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

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

doc/Makefile: fix epub and latexpdf targets

2022-05-10T11:52:34+00:00

Fixing "make clean" followed by "make epub" or "make latexpdf" (From yocto-docs rev: 0dac10fc3d170fb162f4df6547541071bfa7a94e) Signed-off-by: Michael Opdenacker Signed-off-by: Richard Purdie

docs: add poky.yaml and sphinx-static/switchers.js to "make clean"

2022-03-31T10:46:03+00:00

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

Makefile/set_versions: Allow poky.yaml to be autogenerated

2022-03-23T12:08:56+00:00

Use a script to generate the branch/tag information inside poky.yaml. If the branch isn't a known release branch, include git magic to find the closest matching release branch we know about. (From yocto-docs rev: 841e2df0e2e544b82fff9ddd0339a4e775148e3a) Signed-off-by: Richard Purdie

docs: add "make all" to build old types of docs (html, epub, pdf) at once

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

(From yocto-docs rev: 8ce6aa0d4c0985e187464c7578662ff7581bc9ce) Signed-off-by: Michael Opdenacker Reviewed-by: Nicolas Dechesne Signed-off-by: Quentin Schulz 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