diff options
-rw-r--r-- | documentation/Makefile | 3 | ||||
-rw-r--r-- | documentation/README | 14 |
2 files changed, 17 insertions, 0 deletions
diff --git a/documentation/Makefile b/documentation/Makefile index f3b775b3ec..189bd1dfac 100644 --- a/documentation/Makefile +++ b/documentation/Makefile | |||
@@ -53,6 +53,9 @@ stylecheck: | |||
53 | vale sync | 53 | vale sync |
54 | vale $(VALEOPTS) $(VALEDOCS) | 54 | vale $(VALEOPTS) $(VALEDOCS) |
55 | 55 | ||
56 | sphinx-lint: | ||
57 | sphinx-lint $(SOURCEDIR) | ||
58 | |||
56 | epub: $(PNGs) | 59 | epub: $(PNGs) |
57 | $(SOURCEDIR)/set_versions.py | 60 | $(SOURCEDIR)/set_versions.py |
58 | @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) | 61 | @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) |
diff --git a/documentation/README b/documentation/README index 8035418cac..b60472fcbf 100644 --- a/documentation/README +++ b/documentation/README | |||
@@ -165,6 +165,20 @@ To run Vale: | |||
165 | 165 | ||
166 | $ make stylecheck | 166 | $ make stylecheck |
167 | 167 | ||
168 | Link checking the Yocto Project documentation | ||
169 | ============================================= | ||
170 | |||
171 | To fix errors which are not reported by Sphinx itself, | ||
172 | the project uses sphinx-lint (https://github.com/sphinx-contrib/sphinx-lint). | ||
173 | |||
174 | To install sphinx-lint: | ||
175 | |||
176 | $ pip install sphinx-lint | ||
177 | |||
178 | To run sphinx-lint: | ||
179 | |||
180 | $ make sphinx-lint | ||
181 | |||
168 | Sphinx theme and CSS customization | 182 | Sphinx theme and CSS customization |
169 | ================================== | 183 | ================================== |
170 | 184 | ||