summaryrefslogtreecommitdiffstats
path: root/documentation/README
diff options
context:
space:
mode:
authorMichael Opdenacker <michael.opdenacker@bootlin.com>2024-03-12 21:58:39 +0100
committerRichard Purdie <richard.purdie@linuxfoundation.org>2024-03-19 15:22:27 +0000
commite987c5151c34cb388cc1a106a21bdc118206cfac (patch)
tree9f121a698078e93094e3dcb0995f94a7912c4dc7 /documentation/README
parent08081135175e26efb868653d7c9cfd6089576326 (diff)
downloadpoky-e987c5151c34cb388cc1a106a21bdc118206cfac.tar.gz
manuals: add initial stylechecks with Vale
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 <michael.opdenacker@bootlin.com> Suggested-by: Thomas Petazzoni <thomas.petazzoni@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/README')
-rw-r--r--documentation/README14
1 files changed, 14 insertions, 0 deletions
diff --git a/documentation/README b/documentation/README
index 4d31036e69..8035418cac 100644
--- a/documentation/README
+++ b/documentation/README
@@ -151,6 +151,20 @@ dependencies in a virtual environment:
151 $ pipenv install 151 $ pipenv install
152 $ pipenv run make html 152 $ pipenv run make html
153 153
154Style checking the Yocto Project documentation
155==============================================
156
157The project is starting to use Vale (https://vale.sh/)
158to validate the text style.
159
160To install Vale:
161
162 $ pip install vale
163
164To run Vale:
165
166 $ make stylecheck
167
154Sphinx theme and CSS customization 168Sphinx theme and CSS customization
155================================== 169==================================
156 170