[PATCH] dts: remove html dir from dts doc path
Thomas Monjalon
thomas at monjalon.net
Wed Nov 27 01:02:57 CET 2024
26/11/2024 17:25, Paul Szczepanek:
> To facilitate deploying docs to the website
> and make paths more consistent remove the html
> directory from the dts doc path.
>
> Signed-off-by: Paul Szczepanek <paul.szczepanek at arm.com>
> Reviewed-by: Luca Vizzarro <luca.vizzarro at arm.com>
> ---
> # 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)
> + # dts is a special case which doesn't require an html dir in destination path
The comment could be simpler like:
# DTS API doc is already located in the API html dir
> + html_dst = dst if 'dts' in src else join(dst, 'html')
This check is too weak.
It would be better to check for /html/dts in dst
or for /html/ in 1 of the last 2 path children.
> + process = run(sphinx_cmd + ['-b', 'html', src, html_dst], stdout=out)
More information about the dev
mailing list