DPDK patches and discussions
 help / color / mirror / Atom feed
From: Thomas Monjalon <thomas@monjalon.net>
To: dev@dpdk.org
Cc: Thomas Monjalon <thomas@monjalon.net>
Subject: Re: [dpdk-dev] [PATCH] doc: fix build with Sphinx 4
Date: Tue, 11 May 2021 14:41:13 +0200	[thread overview]
Message-ID: <4084746.bSEveYlVSc@thomas> (raw)
In-Reply-To: <20210510204807.289670-1-thomas@monjalon.net>

10/05/2021 22:48, Thomas Monjalon:
> Sphinx 4.0 became stricter with permalink configuration:
> "
> html_add_permalinks has been deprecated since v3.5.0.
> Please use html_permalinks and html_permalinks_icon instead.
> "
> 
> The new variable is used while keeping compatibility
> with older Sphinx versions.

Adding Cc: stable@dpdk.org

> Signed-off-by: Thomas Monjalon <thomas@monjalon.net>

I would like to merge this patch today because I have Sphinx 4
and it is annoying for testing doc build.

> ---
>  doc/guides/conf.py | 5 ++++-
>  1 file changed, 4 insertions(+), 1 deletion(-)
> 
> diff --git a/doc/guides/conf.py b/doc/guides/conf.py
> index ec59aeae7e..c22caaa247 100644
> --- a/doc/guides/conf.py
> +++ b/doc/guides/conf.py
> @@ -31,7 +31,10 @@
>  project = 'Data Plane Development Kit'
>  html_logo = '../logo/DPDK_logo_vertical_rev_small.png'
>  latex_logo = '../logo/DPDK_logo_horizontal_tag.png'
> -html_add_permalinks = ""
> +if LooseVersion(sphinx_version) >= LooseVersion('3.5'):
> +    html_permalinks = False
> +else:
> +    html_add_permalinks = ""
>  html_show_copyright = False
>  highlight_language = 'none'




  reply	other threads:[~2021-05-11 12:41 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-05-10 20:48 Thomas Monjalon
2021-05-11 12:41 ` Thomas Monjalon [this message]
2021-05-11 13:25   ` David Marchand
2021-05-11 14:58     ` Thomas Monjalon
2021-05-11 12:50 ` Bruce Richardson

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=4084746.bSEveYlVSc@thomas \
    --to=thomas@monjalon.net \
    --cc=dev@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).