diff options
| author | Julien Stephan <jstephan@baylibre.com> | 2024-11-04 16:59:13 +0100 |
|---|---|---|
| committer | Steve Sakoman <steve@sakoman.com> | 2024-11-11 06:19:19 -0800 |
| commit | 12c0c4105864a23361083b978ad19cbef7c7b82e (patch) | |
| tree | fb33983942fe8557e7670c66780f3d3963d17162 /documentation/Makefile | |
| parent | 0aeee51c3c149f336e40d49faa442be1e413d038 (diff) | |
| download | poky-12c0c4105864a23361083b978ad19cbef7c7b82e.tar.gz | |
documentation: Makefile: add SPHINXLINTDOCS to specify subset to sphinx-lint
make sphinx-lint runs sphinx-lint on the whole documentation which can be
long and reports a lot or errors/warnings. Let's add a new
SHPINXLINTDOCS variable to allow specifying a subset, just as VALEDOCS
does. Keep variable assignment aligned and also use $(SOURCEDIR) by
default for SPHINXLINTDOCS and VALEDOCS variables.
Also update the README file and fix a typo in Link checking section
title.
(From yocto-docs rev: ae46746897361d4177f3c4284f46753e3aa8c3c3)
Signed-off-by: Julien Stephan <jstephan@baylibre.com>
Reviewed-by: Antonin Godard <antonin.godard@bootlin.com>
Tested-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 3dfe7b5c746af31de74f67cf88214e5d52bdb65d)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
Diffstat (limited to 'documentation/Makefile')
| -rw-r--r-- | documentation/Makefile | 23 |
1 files changed, 12 insertions, 11 deletions
diff --git a/documentation/Makefile b/documentation/Makefile index 4e0af4bd30..580688d543 100644 --- a/documentation/Makefile +++ b/documentation/Makefile | |||
| @@ -3,17 +3,18 @@ | |||
| 3 | 3 | ||
| 4 | # You can set these variables from the command line, and also | 4 | # You can set these variables from the command line, and also |
| 5 | # from the environment for the first two. | 5 | # from the environment for the first two. |
| 6 | SPHINXOPTS ?= -W --keep-going -j auto | 6 | SPHINXOPTS ?= -W --keep-going -j auto |
| 7 | SPHINXBUILD ?= sphinx-build | 7 | SPHINXBUILD ?= sphinx-build |
| 8 | # Release notes are excluded because they contain contributor names and commit messages which can't be modified | 8 | # Release notes are excluded because they contain contributor names and commit messages which can't be modified |
| 9 | VALEOPTS ?= --no-wrap --glob '!migration-guides/release-notes-*.rst' | 9 | VALEOPTS ?= --no-wrap --glob '!migration-guides/release-notes-*.rst' |
| 10 | VALEDOCS ?= . | 10 | SOURCEDIR = . |
| 11 | SOURCEDIR = . | 11 | VALEDOCS ?= $(SOURCEDIR) |
| 12 | IMAGEDIRS = */svg | 12 | SPHINXLINTDOCS ?= $(SOURCEDIR) |
| 13 | BUILDDIR = _build | 13 | IMAGEDIRS = */svg |
| 14 | DESTDIR = final | 14 | BUILDDIR = _build |
| 15 | SVG2PNG = inkscape | 15 | DESTDIR = final |
| 16 | SVG2PDF = inkscape | 16 | SVG2PNG = inkscape |
| 17 | SVG2PDF = inkscape | ||
| 17 | 18 | ||
| 18 | ifeq ($(shell if which $(SPHINXBUILD) >/dev/null 2>&1; then echo 1; else echo 0; fi),0) | 19 | ifeq ($(shell if which $(SPHINXBUILD) >/dev/null 2>&1; then echo 1; else echo 0; fi),0) |
| 19 | $(error "The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed") | 20 | $(error "The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed") |
| @@ -54,7 +55,7 @@ stylecheck: | |||
| 54 | vale $(VALEOPTS) $(VALEDOCS) | 55 | vale $(VALEOPTS) $(VALEDOCS) |
| 55 | 56 | ||
| 56 | sphinx-lint: | 57 | sphinx-lint: |
| 57 | sphinx-lint $(SOURCEDIR) | 58 | sphinx-lint $(SPHINXLINTDOCS) |
| 58 | 59 | ||
| 59 | epub: $(PNGs) | 60 | epub: $(PNGs) |
| 60 | @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) | 61 | @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) |