mirror of
https://git.yoctoproject.org/poky
synced 2026-05-09 05:29:32 +00:00
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: 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>
This commit is contained in:
committed by
Steve Sakoman
parent
85da954465
commit
15034b32a5
+12
-1
@@ -5,6 +5,9 @@
|
||||
# from the environment for the first two.
|
||||
SPHINXOPTS ?= -W --keep-going -j auto
|
||||
SPHINXBUILD ?= sphinx-build
|
||||
# Release notes are excluded because they contain contributor names and commit messages which can't be modified
|
||||
VALEOPTS ?= --no-wrap --glob '!migration-guides/release-notes-*.rst'
|
||||
VALEDOCS ?= .
|
||||
SOURCEDIR = .
|
||||
IMAGEDIRS = */svg
|
||||
BUILDDIR = _build
|
||||
@@ -20,7 +23,7 @@ endif
|
||||
help:
|
||||
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
||||
|
||||
.PHONY: all help Makefile clean publish epub latexpdf
|
||||
.PHONY: all help Makefile clean stylecheck publish epub latexpdf
|
||||
|
||||
publish: Makefile html singlehtml
|
||||
rm -rf $(BUILDDIR)/$(DESTDIR)/
|
||||
@@ -46,6 +49,14 @@ PNGs := $(foreach dir, $(IMAGEDIRS), $(patsubst %.svg,%.png,$(wildcard $(SOURCED
|
||||
clean:
|
||||
@rm -rf $(BUILDDIR) $(PNGs) $(PDFs) poky.yaml sphinx-static/switchers.js
|
||||
|
||||
stylecheck:
|
||||
vale sync
|
||||
vale $(VALEOPTS) $(VALEDOCS)
|
||||
|
||||
stylecheck:
|
||||
vale sync
|
||||
vale $(VALEOPTS) $(VALEDOCS)
|
||||
|
||||
epub: $(PNGs)
|
||||
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
||||
|
||||
|
||||
Reference in New Issue
Block a user