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/README | |
| 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/README')
| -rw-r--r-- | documentation/README | 10 |
1 files changed, 9 insertions, 1 deletions
diff --git a/documentation/README b/documentation/README index a7138c40e2..d7428eb8ed 100644 --- a/documentation/README +++ b/documentation/README | |||
| @@ -173,7 +173,7 @@ directories: | |||
| 173 | $ make stylecheck VALEDOCS="<file1> <file2>" | 173 | $ make stylecheck VALEDOCS="<file1> <file2>" |
| 174 | $ make stylecheck VALEDOCS=<dir> | 174 | $ make stylecheck VALEDOCS=<dir> |
| 175 | 175 | ||
| 176 | Link checking the Yocto Project documentation | 176 | Lint checking the Yocto Project documentation |
| 177 | ============================================= | 177 | ============================================= |
| 178 | 178 | ||
| 179 | To fix errors which are not reported by Sphinx itself, | 179 | To fix errors which are not reported by Sphinx itself, |
| @@ -187,6 +187,14 @@ To run sphinx-lint: | |||
| 187 | 187 | ||
| 188 | $ make sphinx-lint | 188 | $ make sphinx-lint |
| 189 | 189 | ||
| 190 | Lint checking the whole documentation might take some time and generate a | ||
| 191 | lot of warnings/errors, thus one can run sphinx-lint on a subset of files | ||
| 192 | or directories: | ||
| 193 | |||
| 194 | $ make sphinx-lint SPHINXLINTDOCS=<file> | ||
| 195 | $ make sphinx-lint SPHINXLINTDOCS="<file1> <file2>" | ||
| 196 | $ make sphinx-lint SPHINXLINTDOCS=<dir> | ||
| 197 | |||
| 190 | Sphinx theme and CSS customization | 198 | Sphinx theme and CSS customization |
| 191 | ================================== | 199 | ================================== |
| 192 | 200 | ||
