diff --git a/documentation/Makefile b/documentation/Makefile index f3b775b3ec..189bd1dfac 100644 --- a/documentation/Makefile +++ b/documentation/Makefile @@ -53,6 +53,9 @@ stylecheck: vale sync vale $(VALEOPTS) $(VALEDOCS) +sphinx-lint: + sphinx-lint $(SOURCEDIR) + epub: $(PNGs) $(SOURCEDIR)/set_versions.py @$(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: $ make stylecheck +Link checking the Yocto Project documentation +============================================= + +To fix errors which are not reported by Sphinx itself, +the project uses sphinx-lint (https://github.com/sphinx-contrib/sphinx-lint). + +To install sphinx-lint: + + $ pip install sphinx-lint + +To run sphinx-lint: + + $ make sphinx-lint + Sphinx theme and CSS customization ==================================