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 <michael.opdenacker@bootlin.com>
Suggested-by: Thomas Petazzoni <thomas.petazzoni@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
A horrible blunt hammer approach to updating the version information in
switchers.js based on the available tag information.
To merge and work correctly, this will need a change to the autobuilder-helper
docs generation code to pull the swicthers.js and script from master, then
to run the script. That should hopefully remove the need for other patching
even on old docs branches though.
(From yocto-docs rev: dc858c8b2ffdb792fe8cef05fab3d752aa858f78)
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
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 <richard.purdie@linuxfoundation.org>
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 <michael.opdenacker@bootlin.com>
Reviewed-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Adds a Pipfile so that Pipenv can be used to automatically install all
the dependencies required to build the documentation
(From yocto-docs rev: 31658ad30827d38dcd4ea83bcfb828441c7c3eca)
Signed-off-by: Joshua Watt <JPEWhacker@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Used sphinx-quickstart to generate top level config and
Makefile.sphinx, to allow side by side DocBook and Sphinx
co-existence.
(From yocto-docs rev: 01dd5af7954e24552aca022917669b27bb0541ed)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
