[PATCH v4] dts: remove nested html dir for API doc
Thomas Monjalon
thomas at monjalon.net
Fri Nov 29 12:54:26 CET 2024
From: Paul Szczepanek <paul.szczepanek at arm.com>
To facilitate deploying docs to the website
and make paths more consistent remove the html
directory from docs nested in API html directory.
Signed-off-by: Paul Szczepanek <paul.szczepanek at arm.com>
Reviewed-by: Luca Vizzarro <luca.vizzarro at arm.com>
Signed-off-by: Thomas Monjalon <thomas at monjalon.net>
---
v4: fix custom.css path and reword a little
---
buildtools/call-sphinx-build.py | 8 +++++---
doc/api/meson.build | 2 +-
2 files changed, 6 insertions(+), 4 deletions(-)
diff --git a/buildtools/call-sphinx-build.py b/buildtools/call-sphinx-build.py
index 2c7de54285..c891f68ae4 100755
--- a/buildtools/call-sphinx-build.py
+++ b/buildtools/call-sphinx-build.py
@@ -30,8 +30,10 @@
# run sphinx, putting the html output in a "html" directory
with open(join(dst, 'sphinx_html.out'), 'w') as out:
- process = run(sphinx_cmd + ['-b', 'html', src, join(dst, 'html')],
- stdout=out)
+ # don't append html dir if dst is already nested in a html dir
+ last_two_dirs = os.path.join(*os.path.normpath(dst).split(os.path.sep)[-2:])
+ html_dst = dst if 'html' in last_two_dirs else join(dst, 'html')
+ process = run(sphinx_cmd + ['-b', 'html', src, html_dst], stdout=out)
# create a gcc format .d file giving all the dependencies of this doc build
with open(join(dst, '.html.d'), 'w') as d:
@@ -40,7 +42,7 @@
# copy custom CSS file
css = 'custom.css'
src_css = join(src, css)
-dst_css = join(dst, 'html', '_static', 'css', css)
+dst_css = join(html_dst, '_static', 'css', css)
if not os.path.exists(dst_css) or not filecmp.cmp(src_css, dst_css):
os.makedirs(os.path.dirname(dst_css), exist_ok=True)
shutil.copyfile(src_css, dst_css)
diff --git a/doc/api/meson.build b/doc/api/meson.build
index f9f1326bbd..ac6eb8236d 100644
--- a/doc/api/meson.build
+++ b/doc/api/meson.build
@@ -37,7 +37,7 @@ cdata.set('OUTPUT', join_paths(dpdk_build_root, 'doc', 'api'))
cdata.set('TOPDIR', dpdk_source_root)
cdata.set('STRIP_FROM_PATH', ' '.join([dpdk_source_root, join_paths(dpdk_build_root, 'doc', 'api')]))
cdata.set('WARN_AS_ERROR', 'NO')
-cdata.set('DTS_API_MAIN_PAGE', join_paths('.', 'dts', 'html', 'index.html'))
+cdata.set('DTS_API_MAIN_PAGE', join_paths('.', 'dts', 'index.html'))
if get_option('werror')
cdata.set('WARN_AS_ERROR', 'YES')
endif
--
2.47.1
More information about the dev
mailing list