diff options
author | Antonin Godard <antonin.godard@bootlin.com> | 2025-07-29 13:30:03 +0200 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2025-08-08 23:41:11 +0100 |
commit | facbd11e90d6da516b0d89e4dcdb7fe430c62822 (patch) | |
tree | 6f65c6bfac46bd752b33a10617eb44843ee6bb3b /documentation | |
parent | dc768a3d9d6df0cd048bf7ded4773372929f1675 (diff) | |
download | poky-facbd11e90d6da516b0d89e4dcdb7fe430c62822.tar.gz |
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 <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r-- | documentation/Makefile | 7 |
1 files changed, 5 insertions, 2 deletions
diff --git a/documentation/Makefile b/documentation/Makefile index 65e29713d4..bade78fe88 100644 --- a/documentation/Makefile +++ b/documentation/Makefile | |||
@@ -24,9 +24,9 @@ endif | |||
24 | help: | 24 | help: |
25 | @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) | 25 | @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) |
26 | 26 | ||
27 | .PHONY: all help Makefile clean stylecheck publish epub latexpdf | 27 | .PHONY: all checks help Makefile clean stylecheck publish epub latexpdf |
28 | 28 | ||
29 | publish: Makefile epub latexpdf html singlehtml | 29 | publish: Makefile checks epub latexpdf html singlehtml |
30 | rm -rf $(BUILDDIR)/$(DESTDIR)/ | 30 | rm -rf $(BUILDDIR)/$(DESTDIR)/ |
31 | mkdir -p $(BUILDDIR)/$(DESTDIR)/ | 31 | mkdir -p $(BUILDDIR)/$(DESTDIR)/ |
32 | cp -r $(BUILDDIR)/html/* $(BUILDDIR)/$(DESTDIR)/ | 32 | cp -r $(BUILDDIR)/html/* $(BUILDDIR)/$(DESTDIR)/ |
@@ -52,6 +52,9 @@ PNGs := $(foreach dir, $(IMAGEDIRS), $(patsubst %.svg,%.png,$(wildcard $(SOURCED | |||
52 | clean: | 52 | clean: |
53 | @rm -rf $(BUILDDIR) $(PNGs) $(PDFs) poky.yaml sphinx-static/switchers.js releases.rst | 53 | @rm -rf $(BUILDDIR) $(PNGs) $(PDFs) poky.yaml sphinx-static/switchers.js releases.rst |
54 | 54 | ||
55 | checks: | ||
56 | $(SOURCEDIR)/tools/check-glossaries --docs-dir $(SOURCEDIR) | ||
57 | |||
55 | stylecheck: | 58 | stylecheck: |
56 | vale sync | 59 | vale sync |
57 | vale $(VALEOPTS) $(VALEDOCS) | 60 | vale $(VALEOPTS) $(VALEDOCS) |