[PATCH v3] dts: remove html dir from nested docs
Paul Szczepanek
paul.szczepanek at arm.com
Fri Nov 29 00:05:15 CET 2024
To facilitate deploying docs to the website
and make paths more consistent remove the html
directory from docs nested in html directories.
Signed-off-by: Paul Szczepanek <paul.szczepanek at arm.com>
Reviewed-by: Luca Vizzarro <luca.vizzarro at arm.com>
---
buildtools/call-sphinx-build.py | 6 ++++--
doc/api/meson.build | 2 +-
2 files changed, 5 insertions(+), 3 deletions(-)
diff --git a/buildtools/call-sphinx-build.py b/buildtools/call-sphinx-build.py
index 2c7de54285..3e5fc813a2 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
+ top_2_dirs = os.path.join(*os.path.normpath(dst).split(os.path.sep)[-2:])
+ html_dst = dst if 'html' in top_2_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:
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.39.2
More information about the dev
mailing list