mirror of
git://git.yoctoproject.org/poky.git
synced 2025-07-19 21:09:03 +02:00
a69d74c842
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>
48 lines
1.3 KiB
Python
48 lines
1.3 KiB
Python
#!/usr/bin/env python
|
|
import re
|
|
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
|
|
# Each .rst file is processed after source-read event (subst_vars_replace runs once per file)
|
|
subst_vars = {}
|
|
|
|
def subst_vars_replace(app: Sphinx, docname, source):
|
|
result = source[0]
|
|
for k in subst_vars:
|
|
result = result.replace("&"+k+";", subst_vars[k])
|
|
source[0] = result
|
|
|
|
PATTERN = re.compile(r'&(.*?);')
|
|
def expand(val, src):
|
|
return PATTERN.sub(lambda m: expand(src.get(m.group(1), ''), src), val)
|
|
|
|
def setup(app: Sphinx):
|
|
#FIXME: if poky.yaml changes, files are not reprocessed.
|
|
with open("poky.yaml") as file:
|
|
subst_vars.update(yaml.load(file, Loader=yaml.FullLoader))
|
|
|
|
for k in subst_vars:
|
|
subst_vars[k] = expand(subst_vars[k], subst_vars)
|
|
|
|
app.connect('source-read', subst_vars_replace)
|
|
|
|
return dict(
|
|
version = __version__,
|
|
parallel_read_safe = True,
|
|
parallel_write_safe = True
|
|
)
|