From 12c0c4105864a23361083b978ad19cbef7c7b82e Mon Sep 17 00:00:00 2001 From: Julien Stephan Date: Mon, 4 Nov 2024 16:59:13 +0100 Subject: documentation: Makefile: add SPHINXLINTDOCS to specify subset to sphinx-lint make sphinx-lint runs sphinx-lint on the whole documentation which can be long and reports a lot or errors/warnings. Let's add a new SHPINXLINTDOCS variable to allow specifying a subset, just as VALEDOCS does. Keep variable assignment aligned and also use $(SOURCEDIR) by default for SPHINXLINTDOCS and VALEDOCS variables. Also update the README file and fix a typo in Link checking section title. (From yocto-docs rev: ae46746897361d4177f3c4284f46753e3aa8c3c3) Signed-off-by: Julien Stephan Reviewed-by: Antonin Godard Tested-by: Antonin Godard Signed-off-by: Antonin Godard (cherry picked from commit 3dfe7b5c746af31de74f67cf88214e5d52bdb65d) Signed-off-by: Antonin Godard Signed-off-by: Steve Sakoman --- documentation/README | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) (limited to 'documentation/README') diff --git a/documentation/README b/documentation/README index a7138c40e2..d7428eb8ed 100644 --- a/documentation/README +++ b/documentation/README @@ -173,7 +173,7 @@ directories: $ make stylecheck VALEDOCS=" " $ make stylecheck VALEDOCS= -Link checking the Yocto Project documentation +Lint checking the Yocto Project documentation ============================================= To fix errors which are not reported by Sphinx itself, @@ -187,6 +187,14 @@ To run sphinx-lint: $ make sphinx-lint +Lint checking the whole documentation might take some time and generate a +lot of warnings/errors, thus one can run sphinx-lint on a subset of files +or directories: + + $ make sphinx-lint SPHINXLINTDOCS= + $ make sphinx-lint SPHINXLINTDOCS=" " + $ make sphinx-lint SPHINXLINTDOCS= + Sphinx theme and CSS customization ================================== -- cgit v1.2.3-54-g00ecf