mirrors/poky
1
0
Fork 0
mirror of https://git.yoctoproject.org/poky synced 2026-06-03 13:49:49 +00:00
Code Issues Projects Releases Wiki Activity

manuals: add initial stylechecks with Vale

Browse Source 
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: 198efc906efbbaced2526cd1221fd16ab35996a1)

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>
This commit is contained in:
Michael Opdenacker
2024-03-12 21:58:39 +01:00
committed by Steve Sakoman
parent 9090e89240
commit 4745719d0b
7 changed files with 58 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
documentation/README
+14
View File
@@ -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
==================================