summaryrefslogtreecommitdiffstats
path: root/documentation/README
diff options
context:
space:
mode:
Diffstat (limited to 'documentation/README')
-rw-r--r--documentation/README14
1 files changed, 14 insertions, 0 deletions
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
168Link checking the Yocto Project documentation
169=============================================
170
171To fix errors which are not reported by Sphinx itself,
172the project uses sphinx-lint (https://github.com/sphinx-contrib/sphinx-lint).
173
174To install sphinx-lint:
175
176 $ pip install sphinx-lint
177
178To run sphinx-lint:
179
180 $ make sphinx-lint
181
168Sphinx theme and CSS customization 182Sphinx theme and CSS customization
169================================== 183==================================
170 184