diff mbox series

doc: fix build with Sphinx 4

Message ID 20210510204807.289670-1-thomas@monjalon.net (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers show
Series doc: fix build with Sphinx 4 | expand

Checks

Context Check Description
ci/github-robot success github build: passed
ci/intel-Testing success Testing PASS
ci/Intel-compilation success Compilation OK
ci/checkpatch success coding style OK

Commit Message

Thomas Monjalon May 10, 2021, 8:48 p.m. UTC
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.

Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
---
 doc/guides/conf.py | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

Comments

Thomas Monjalon May 11, 2021, 12:41 p.m. UTC | #1
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'
Bruce Richardson May 11, 2021, 12:50 p.m. UTC | #2
On Mon, May 10, 2021 at 10:48:07PM +0200, Thomas Monjalon wrote:
> 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.
> 
> Signed-off-by: Thomas Monjalon <thomas@monjalon.net>

Acked-by: Bruce Richardson <bruce.richardson@intel.com>
David Marchand May 11, 2021, 1:25 p.m. UTC | #3
On Tue, May 11, 2021 at 2:41 PM Thomas Monjalon <thomas@monjalon.net> wrote:
>
> 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>

Tested with fc32 and (bleeding edge) 4.0.0 sphinx.
Reviewed-by: David Marchand <david.marchand@redhat.com>
Thomas Monjalon May 11, 2021, 2:58 p.m. UTC | #4
11/05/2021 15:25, David Marchand:
> On Tue, May 11, 2021 at 2:41 PM Thomas Monjalon <thomas@monjalon.net> wrote:
> >
> > 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>
> 
> Tested with fc32 and (bleeding edge) 4.0.0 sphinx.
> Reviewed-by: David Marchand <david.marchand@redhat.com>

Applied
diff mbox series

Patch

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'