DPDK patches and discussions
 help / color / mirror / Atom feed
From: Thomas Monjalon <thomas@monjalon.net>
To: Paul Szczepanek <paul.szczepanek@arm.com>
Cc: dev@dpdk.org, Luca Vizzarro <luca.vizzarro@arm.com>
Subject: Re: [PATCH] dts: remove html dir from dts doc path
Date: Wed, 27 Nov 2024 01:02:57 +0100	[thread overview]
Message-ID: <4540133.OBFZWjSADL@thomas> (raw)
In-Reply-To: <20241126162506.1074550-1-paul.szczepanek@arm.com>

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@arm.com>
> Reviewed-by: Luca Vizzarro <luca.vizzarro@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)




  reply	other threads:[~2024-11-27  0:03 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-11-26 16:25 Paul Szczepanek
2024-11-27  0:02 ` Thomas Monjalon [this message]
2024-11-27 11:41 ` [PATCH v2] docs: remove html dir from nested docs Paul Szczepanek
2024-11-27 12:35   ` Thomas Monjalon
2024-11-28 23:05 ` [PATCH v3] dts: " Paul Szczepanek
2024-11-29 11:39   ` Thomas Monjalon
2024-11-29 11:54 ` [PATCH v4] dts: remove nested html dir for API doc Thomas Monjalon
2024-11-29 12:15   ` Paul Szczepanek
2024-11-29 12:59     ` Thomas Monjalon

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=4540133.OBFZWjSADL@thomas \
    --to=thomas@monjalon.net \
    --cc=dev@dpdk.org \
    --cc=luca.vizzarro@arm.com \
    --cc=paul.szczepanek@arm.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).