mirror of
https://github.com/zephyrproject-rtos/zephyr
synced 2025-09-10 11:51:55 +00:00
e182dbc22e
The following changes have been made to support out-of-tree builds: * In order to avoid using relative hardcoded paths, use CMake's configure_file() to replace the paths in the doxygen input file so that the output directory is set correctly. * All .rst and additional required files are now copied from the doc/ folder into the build/rst folder using extract_content.py. The samples/ and boards/ folder are copied twice (once into build/rst and another into build/doc/rst) to manage relative paths. * All paths are absolute where possible, including themes and static content. This patch ensures that the Zephyr repo is not contaminated by the build at all. Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
107 lines
3.3 KiB
Python
Executable File
107 lines
3.3 KiB
Python
Executable File
#!/usr/bin/env python3
|
|
#
|
|
# Copyright (c) 2018, Nordic Semiconductor ASA
|
|
# Copyright (c) 2017, Intel Corporation
|
|
#
|
|
# SPDX-License-Identifier: Apache-2.0
|
|
|
|
# Very quick script to move docs from different places into the doc directory
|
|
# to fix the website and external links
|
|
|
|
import errno
|
|
import filecmp
|
|
import fnmatch
|
|
import os
|
|
import re
|
|
import shutil
|
|
import sys
|
|
|
|
# directives to parse for included files
|
|
DIRECTIVES = ["figure","include","image","literalinclude"]
|
|
|
|
if "ZEPHYR_BASE" not in os.environ:
|
|
sys.stderr.write("$ZEPHYR_BASE environment variable undefined.\n")
|
|
exit(1)
|
|
ZEPHYR_BASE = os.environ["ZEPHYR_BASE"]
|
|
|
|
if "ZEPHYR_BUILD" in os.environ:
|
|
ZEPHYR_BUILD = os.environ["ZEPHYR_BUILD"]
|
|
else:
|
|
ZEPHYR_BUILD = None
|
|
|
|
def copy_if_different(src, dst):
|
|
# Copies 'src' as 'dst', but only if dst does not exist or if itx contents
|
|
# differ from src.This avoids unnecessary # timestamp updates, which
|
|
# trigger documentation rebuilds.
|
|
if os.path.exists(dst) and filecmp.cmp(src, dst):
|
|
return
|
|
shutil.copyfile(src, dst)
|
|
|
|
def get_rst_files(dest, dir):
|
|
matches = []
|
|
for root, dirnames, filenames in os.walk('%s/%s' %(ZEPHYR_BASE, dir)):
|
|
if ZEPHYR_BUILD:
|
|
if os.path.normpath(root).startswith(os.path.normpath(ZEPHYR_BUILD)):
|
|
# Build folder, skip it
|
|
continue
|
|
for filename in fnmatch.filter(filenames, '*.rst'):
|
|
matches.append(os.path.join(root, filename))
|
|
for file in matches:
|
|
frel = file.replace(ZEPHYR_BASE,"").strip("/")
|
|
dir=os.path.dirname(frel)
|
|
if not os.path.exists(os.path.join(dest, dir)):
|
|
os.makedirs(os.path.join(dest, dir))
|
|
|
|
copy_if_different(file, os.path.join(dest, frel))
|
|
|
|
try:
|
|
with open(file, encoding="utf-8") as f:
|
|
content = f.readlines()
|
|
|
|
content = [x.strip() for x in content]
|
|
directives = "|".join(DIRECTIVES)
|
|
pattern = re.compile("\s*\.\.\s+(%s)::\s+(.*)" %directives)
|
|
for l in content:
|
|
m = pattern.match(l)
|
|
if m:
|
|
inf = m.group(2)
|
|
ind = os.path.dirname(inf)
|
|
if not os.path.exists(os.path.join(dest, dir, ind)):
|
|
os.makedirs(os.path.join(dest, dir, ind))
|
|
|
|
src = os.path.join(ZEPHYR_BASE, dir, inf)
|
|
dst = os.path.join(dest, dir, inf)
|
|
try:
|
|
copy_if_different(src, dst)
|
|
|
|
except FileNotFoundError:
|
|
sys.stderr.write("File not found: %s\n reference by %s\n" % (inf, file))
|
|
|
|
except UnicodeDecodeError as e:
|
|
sys.stderr.write(
|
|
"Malformed {} in {}\n"
|
|
" Context: {}\n"
|
|
" Problematic data: {}\n"
|
|
" Reason: {}\n".format(
|
|
e.encoding, file,
|
|
e.object[max(e.start - 40, 0):e.end + 40],
|
|
e.object[e.start:e.end],
|
|
e.reason))
|
|
|
|
f.close()
|
|
|
|
def main():
|
|
|
|
if len(sys.argv) < 3:
|
|
print("usage: {} <dest> <org dirs>", file=sys.stderr)
|
|
sys.exit(1)
|
|
|
|
dest = sys.argv[1]
|
|
content_dirs = sys.argv[2:]
|
|
|
|
for d in content_dirs:
|
|
get_rst_files(dest, d)
|
|
|
|
if __name__ == "__main__":
|
|
main()
|