diff options
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 | ||