From facbd11e90d6da516b0d89e4dcdb7fe430c62822 Mon Sep 17 00:00:00 2001 From: Antonin Godard Date: Tue, 29 Jul 2025 13:30:03 +0200 Subject: Makefile: add a checks rule The checks rule can be run to perform some checks on the docs. For now it only includes running the check-glossaries script. This rule should only run basic checks or should not prevent the user from building the docs in case of failure. This rule can be used in the future to run additional checks on the documentation. (From yocto-docs rev: 1d9a4a52fa9f2e2eb7f282324f85a46b28128fbf) Signed-off-by: Antonin Godard Signed-off-by: Richard Purdie --- documentation/Makefile | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) (limited to 'documentation') diff --git a/documentation/Makefile b/documentation/Makefile index 65e29713d4..bade78fe88 100644 --- a/documentation/Makefile +++ b/documentation/Makefile @@ -24,9 +24,9 @@ endif help: @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) -.PHONY: all help Makefile clean stylecheck publish epub latexpdf +.PHONY: all checks help Makefile clean stylecheck publish epub latexpdf -publish: Makefile epub latexpdf html singlehtml +publish: Makefile checks epub latexpdf html singlehtml rm -rf $(BUILDDIR)/$(DESTDIR)/ mkdir -p $(BUILDDIR)/$(DESTDIR)/ cp -r $(BUILDDIR)/html/* $(BUILDDIR)/$(DESTDIR)/ @@ -52,6 +52,9 @@ PNGs := $(foreach dir, $(IMAGEDIRS), $(patsubst %.svg,%.png,$(wildcard $(SOURCED clean: @rm -rf $(BUILDDIR) $(PNGs) $(PDFs) poky.yaml sphinx-static/switchers.js releases.rst +checks: + $(SOURCEDIR)/tools/check-glossaries --docs-dir $(SOURCEDIR) + stylecheck: vale sync vale $(VALEOPTS) $(VALEDOCS) -- cgit v1.2.3-54-g00ecf