From e987c5151c34cb388cc1a106a21bdc118206cfac Mon Sep 17 00:00:00 2001 From: Michael Opdenacker Date: Tue, 12 Mar 2024 21:58:39 +0100 Subject: 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 Suggested-by: Thomas Petazzoni Signed-off-by: Richard Purdie --- documentation/README | 14 ++++++++++++++ 1 file changed, 14 insertions(+) (limited to 'documentation/README') 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: $ pipenv install $ pipenv run make html +Style checking the Yocto Project documentation +============================================== + +The project is starting to use Vale (https://vale.sh/) +to validate the text style. + +To install Vale: + + $ pip install vale + +To run Vale: + + $ make stylecheck + Sphinx theme and CSS customization ================================== -- cgit v1.2.3-54-g00ecf