diff options
author | Julien Stephan <jstephan@baylibre.com> | 2024-11-04 16:59:13 +0100 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2024-11-07 10:12:24 +0000 |
commit | 304312bd8ce0793e25d83d5ff53069a95d87e777 (patch) | |
tree | d89caaeb577ff74f395adf4f3b70e237c899531c /documentation/README | |
parent | 7d88e832b5ee4f25d1c50c1e24781ef83670f05d (diff) | |
download | poky-304312bd8ce0793e25d83d5ff53069a95d87e777.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: 3dfe7b5c746af31de74f67cf88214e5d52bdb65d)
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>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
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 8ac8d52367..8a47fd4a3f 100644 --- a/documentation/README +++ b/documentation/README | |||
@@ -150,7 +150,7 @@ directories: | |||
150 | $ make stylecheck VALEDOCS="<file1> <file2>" | 150 | $ make stylecheck VALEDOCS="<file1> <file2>" |
151 | $ make stylecheck VALEDOCS=<dir> | 151 | $ make stylecheck VALEDOCS=<dir> |
152 | 152 | ||
153 | Link checking the Yocto Project documentation | 153 | Lint checking the Yocto Project documentation |
154 | ============================================= | 154 | ============================================= |
155 | 155 | ||
156 | To fix errors which are not reported by Sphinx itself, | 156 | To fix errors which are not reported by Sphinx itself, |
@@ -164,6 +164,14 @@ To run sphinx-lint: | |||
164 | 164 | ||
165 | $ make sphinx-lint | 165 | $ make sphinx-lint |
166 | 166 | ||
167 | Lint checking the whole documentation might take some time and generate a | ||
168 | lot of warnings/errors, thus one can run sphinx-lint on a subset of files | ||
169 | or directories: | ||
170 | |||
171 | $ make sphinx-lint SPHINXLINTDOCS=<file> | ||
172 | $ make sphinx-lint SPHINXLINTDOCS="<file1> <file2>" | ||
173 | $ make sphinx-lint SPHINXLINTDOCS=<dir> | ||
174 | |||
167 | Sphinx theme and CSS customization | 175 | Sphinx theme and CSS customization |
168 | ================================== | 176 | ================================== |
169 | 177 | ||