michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: extract_content.py: Detect included files in a more robust way

Browse source 
Allow '.. <figure/include/image/...>:: <path>' to appear anywhere within
a line, and find multiple directives on a single line. This is needed to
find files included e.g. within tables.

Implemented by making the <path> part of the regex more specific and
searching for matches anywhere within the contents of the file. Should
be a bit faster too.

Maybe there's some tiny potential for false positives, but this
generates the same file list as the old version for the current docs at
least.

Fixes: #21466

Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
This commit is contained in:
Ulf Magnusson 2019-12-19 07:36:11 +01:00 • committed by Anas Nashif
commit ea3041dbbe
1 changed files with 3 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

10
doc/scripts/extract_content.py
View file

@ -59,7 +59,7 @@ def src_deps(zephyr_base, src_file, dest, src_root):
# Load the file's contents, bailing on decode errors.
try:
with open(src_file, encoding="utf-8") as f:
content = [x.strip() for x in f.readlines()]
content = f.read()
except UnicodeDecodeError as e:
# pylint: disable=unsubscriptable-object
sys.stderr.write(
@ -83,14 +83,10 @@ def src_deps(zephyr_base, src_file, dest, src_root):
# argument, which is a (relative) path to the additional
# dependency file.
directives = "|".join(DIRECTIVES)
pattern = re.compile(r"\.\.\s+(?P<directive>%s)::\s+(?P<dep_rel>.*)" %
pattern = re.compile(r"\.\.\s+(?P<directive>%s)::\s+(?P<dep_rel>[^\s]+)" %
directives)
deps = []
for l in content:
m = pattern.match(l)
if not m:
continue
for m in pattern.finditer(content):
dep_rel = m.group('dep_rel') # relative to src_dir or absolute
dep_src = path.abspath(path.join(src_dir, dep_rel))
if path.isabs(dep_rel):