@@ -3,17 +3,18 @@
# You can set these variables from the command line, and also
# from the environment for the first two.
-SPHINXOPTS ?= -W --keep-going -j auto
-SPHINXBUILD ?= sphinx-build
+SPHINXOPTS ?= -W --keep-going -j auto
+SPHINXBUILD ?= sphinx-build
# Release notes are excluded because they contain contributor names and commit messages which can't be modified
-VALEOPTS ?= --no-wrap --glob '!migration-guides/release-notes-*.rst'
-VALEDOCS ?= .
-SOURCEDIR = .
-IMAGEDIRS = */svg
-BUILDDIR = _build
-DESTDIR = final
-SVG2PNG = inkscape
-SVG2PDF = inkscape
+VALEOPTS ?= --no-wrap --glob '!migration-guides/release-notes-*.rst'
+SOURCEDIR = .
+VALEDOCS ?= $(SOURCEDIR)
+SPHINXLINTDOCS ?= $(SOURCEDIR)
+IMAGEDIRS = */svg
+BUILDDIR = _build
+DESTDIR = final
+SVG2PNG = inkscape
+SVG2PDF = inkscape
ifeq ($(shell if which $(SPHINXBUILD) >/dev/null 2>&1; then echo 1; else echo 0; fi),0)
$(error "The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed")
@@ -54,7 +55,7 @@ stylecheck:
vale $(VALEOPTS) $(VALEDOCS)
sphinx-lint:
- sphinx-lint $(SOURCEDIR)
+ sphinx-lint $(SPHINXLINTDOCS)
epub: $(PNGs)
$(SOURCEDIR)/set_versions.py
@@ -150,7 +150,7 @@ directories:
$ make stylecheck VALEDOCS="<file1> <file2>"
$ make stylecheck VALEDOCS=<dir>
-Link checking the Yocto Project documentation
+Lint checking the Yocto Project documentation
=============================================
To fix errors which are not reported by Sphinx itself,
@@ -164,6 +164,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=<file>
+ $ make sphinx-lint SPHINXLINTDOCS="<file1> <file2>"
+ $ make sphinx-lint SPHINXLINTDOCS=<dir>
+
Sphinx theme and CSS customization
==================================
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. Signed-off-by: Julien Stephan <jstephan@baylibre.com> --- documentation/Makefile | 23 ++++++++++++----------- documentation/README | 10 +++++++++- 2 files changed, 21 insertions(+), 12 deletions(-)