DPDK patches and discussions
 help / color / mirror / Atom feed
From: Thomas Monjalon <thomas@monjalon.net>
To: David Marchand <david.marchand@redhat.com>,
	Aaron Conole <aconole@redhat.com>
Cc: dev@dpdk.org, stable@dpdk.org, John McNamara <john.mcnamara@intel.com>
Subject: Re: [dpdk-dev] [PATCH] doc: fix sphinx rtd theme import in GHA
Date: Fri, 02 Apr 2021 01:59:29 +0200	[thread overview]
Message-ID: <5804841.bASGPeqdAi@thomas> (raw)
In-Reply-To: <f7teeftspvt.fsf@dhcp-25.97.bos.redhat.com>

01/04/2021 22:37, Aaron Conole:
> David Marchand <david.marchand@redhat.com> writes:
> 
> > If the rtd theme is available, passing it by name is enough to select
> > it. Sphinx itself recognises the "sphinx_rtd_theme" name as a special
> > case and tries to find its path automatically.
> >
> > On the other hand, passing a html_theme_path makes sphinx parse all
> > themes availables in this path, which in some environment (like GHA) is
> > /usr/share and makes sphinx error on the first zipfile it finds (in GHA,
> > some Azure CLI thingy) that has no sphinx theme in it.
> >
> > Fixes: 46562be65094 ("doc: import sphinx rtd theme when available")
> > Cc: stable@dpdk.org
> >
> > Signed-off-by: David Marchand <david.marchand@redhat.com>
> > ---
> 
> https://github.com/ovsrobot/dpdk/tree/series_16066
> https://github.com/ovsrobot/dpdk/actions/runs/709682570
> 
> Acked-by: Aaron Conole <aconole@redhat.com>

Applied, thanks for the quick workaround.

This patch is removing html_theme_path,
not sure in which situation it was useful.
Future will tell.

From sphinx doc:
"
If the theme does not come with Sphinx, it can be in two static forms or as a Python package. For the static forms, either a directory (containing theme.conf and other needed files), or a zip file with the same contents is supported. The directory or zipfile must be put where Sphinx can find it; for this there is the config value html_theme_path. This can be a list of directories, relative to the directory containing conf.py, that can contain theme directories or zip files.
"




      reply	other threads:[~2021-04-01 23:59 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-04-01 19:58 David Marchand
2021-04-01 20:37 ` Aaron Conole
2021-04-01 23:59   ` Thomas Monjalon [this message]

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=5804841.bASGPeqdAi@thomas \
    --to=thomas@monjalon.net \
    --cc=aconole@redhat.com \
    --cc=david.marchand@redhat.com \
    --cc=dev@dpdk.org \
    --cc=john.mcnamara@intel.com \
    --cc=stable@dpdk.org \
    /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).