summaryrefslogtreecommitdiffstats
path: root/documentation/Makefile.sphinx
diff options
context:
space:
mode:
authorNicolas Dechesne <nicolas.dechesne@linaro.org>2020-09-18 10:14:14 +0200
committerRichard Purdie <richard.purdie@linuxfoundation.org>2020-09-22 09:58:50 +0100
commita69d74c842a0f55ffa1408fa058138ac9637a0c6 (patch)
tree627d569efd58720c2fe8478d7d624cb83d76db3d /documentation/Makefile.sphinx
parentd6ce950527981cf468f7091e5937333ad080e8b6 (diff)
downloadpoky-a69d74c842a0f55ffa1408fa058138ac9637a0c6.tar.gz
sphinx: report errors when dependencies are not met
To build the Sphinx documentation, we have the following dependencies: * sphinx * sphinx_rtd_theme * pyyaml If any of these dependencies are missing, we might end up with some cryptic error messages. This patch adds better error reporting when dependencies are not met. (From yocto-docs rev: 19df8d1ec56dc2ecb44122288cc53e84237fab69) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/Makefile.sphinx')
-rw-r--r--documentation/Makefile.sphinx4
1 files changed, 4 insertions, 0 deletions
diff --git a/documentation/Makefile.sphinx b/documentation/Makefile.sphinx
index c663c29540..c9518558bb 100644
--- a/documentation/Makefile.sphinx
+++ b/documentation/Makefile.sphinx
@@ -9,6 +9,10 @@ SOURCEDIR = .
9BUILDDIR = _build 9BUILDDIR = _build
10DESTDIR = final 10DESTDIR = final
11 11
12ifeq ($(shell if which $(SPHINXBUILD) >/dev/null 2>&1; then echo 1; else echo 0; fi),0)
13$(error "The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed")
14endif
15
12# Put it first so that "make" without argument is like "make help". 16# Put it first so that "make" without argument is like "make help".
13help: 17help:
14 @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) 18 @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)