summaryrefslogtreecommitdiffstats
path: root/documentation/conf.py
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/conf.py
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/conf.py')
-rw-r--r--documentation/conf.py14
1 files changed, 10 insertions, 4 deletions
diff --git a/documentation/conf.py b/documentation/conf.py
index 34d1bc97a4..f2dd2556fa 100644
--- a/documentation/conf.py
+++ b/documentation/conf.py
@@ -91,10 +91,16 @@ intersphinx_mapping = {
91# The theme to use for HTML and HTML Help pages. See the documentation for 91# The theme to use for HTML and HTML Help pages. See the documentation for
92# a list of builtin themes. 92# a list of builtin themes.
93# 93#
94html_theme = 'sphinx_rtd_theme' 94try:
95html_theme_options = { 95 import sphinx_rtd_theme
96 'sticky_navigation': False, 96 html_theme = 'sphinx_rtd_theme'
97} 97 html_theme_options = {
98 'sticky_navigation': False,
99 }
100except ImportError:
101 sys.stderr.write("The Sphinx sphinx_rtd_theme HTML theme was not found.\
102 \nPlease make sure to install the sphinx_rtd_theme python package.\n")
103 sys.exit(1)
98 104
99html_logo = 'sphinx-static/YoctoProject_Logo_RGB.jpg' 105html_logo = 'sphinx-static/YoctoProject_Logo_RGB.jpg'
100 106