All of lore.kernel.org
 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 v3] dts: remove html dir from nested docs
Date: Fri, 29 Nov 2024 12:39:26 +0100	[thread overview]
Message-ID: <7740087.EvYhyI6sBW@thomas> (raw)
In-Reply-To: <20241128230515.1125653-1-paul.szczepanek@arm.com>

29/11/2024 00:05, Paul Szczepanek:
> 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@arm.com>
> Reviewed-by: Luca Vizzarro <luca.vizzarro@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)

There is still a file in the extra html directory:

build/doc/api/html/dts/html/_static/css/custom.css

I suppose that we need to change this line:

dst_css = join(dst, 'html', '_static', 'css', css)

into

dst_css = join(html_dst, '_static', 'css', css)

Then it should become this path:

build/doc/api/html/dts/_static/css/custom.css



  reply	other threads:[~2024-11-29 11:39 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-11-26 16:25 [PATCH] dts: remove html dir from dts doc path Paul Szczepanek
2024-11-27  0:02 ` Thomas Monjalon
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 [this message]
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=7740087.EvYhyI6sBW@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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.