From a6fdddf8c44367a5bd82ba9d979e708bd710db79 Mon Sep 17 00:00:00 2001 From: Michael Opdenacker Date: Sat, 30 Mar 2024 17:32:47 +0100 Subject: [PATCH] manuals: add initial sphinx-lint support Makes it possible to catch errors not reported by sphinx, such as idle spaces. After customization, this should be used to enforce our syntax conventions, such as two spaces after a "-" character to introduce a list item. Just run "make sphinx-lint". (From yocto-docs rev: a735549a764f7cfebdc7534761b4d75dc523371a) Signed-off-by: Michael Opdenacker Signed-off-by: Steve Sakoman --- documentation/Makefile | 3 +++ documentation/README | 14 ++++++++++++++ 2 files changed, 17 insertions(+) diff --git a/documentation/Makefile b/documentation/Makefile index 20dab5725c..4e0af4bd30 100644 --- a/documentation/Makefile +++ b/documentation/Makefile @@ -53,6 +53,9 @@ stylecheck: vale sync vale $(VALEOPTS) $(VALEDOCS) +sphinx-lint: + sphinx-lint $(SOURCEDIR) + epub: $(PNGs) @$(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 ==================================