diff options
| -rw-r--r-- | documentation/Makefile.sphinx | 4 | ||||
| -rw-r--r-- | documentation/conf.py | 14 | ||||
| -rw-r--r-- | documentation/sphinx/yocto-vars.py | 11 |
3 files changed, 24 insertions, 5 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 = . BUILDDIR = _build DESTDIR = final +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") +endif + # Put it first so that "make" without argument is like "make help". help: @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) 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 = { # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # -html_theme = 'sphinx_rtd_theme' -html_theme_options = { - 'sticky_navigation': False, -} +try: + import sphinx_rtd_theme + html_theme = 'sphinx_rtd_theme' + html_theme_options = { + 'sticky_navigation': False, + } +except ImportError: + sys.stderr.write("The Sphinx sphinx_rtd_theme HTML theme was not found.\ + \nPlease make sure to install the sphinx_rtd_theme python package.\n") + sys.exit(1) html_logo = 'sphinx-static/YoctoProject_Logo_RGB.jpg' diff --git a/documentation/sphinx/yocto-vars.py b/documentation/sphinx/yocto-vars.py index 5689472991..8083d7da19 100644 --- a/documentation/sphinx/yocto-vars.py +++ b/documentation/sphinx/yocto-vars.py @@ -1,10 +1,19 @@ #!/usr/bin/env python import re -import yaml +import sys import sphinx from sphinx.application import Sphinx +# This extension uses pyyaml, report an explicit +# error message if it's not installed +try: + import yaml +except ImportError: + sys.stderr.write("The Yocto Project Sphinx documentation requires PyYAML.\ + \nPlease make sure to install pyyaml python package.\n") + sys.exit(1) + __version__ = '1.0' # Variables substitutions. Uses {VAR} subst using variables defined in poky.yaml |