[PATCH] dts: fix Sphinx parsing of a docstring

[PATCH] dts: fix Sphinx parsing of a docstring

[Thomas Monjalon]

With Sphinx 9.1.0, the word "ports" is wrongly parsed as a reference,
and the doc fails to generate.
Splitting the docstring (as the next one) seems to be a workaround.

Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
---
 dts/api/testpmd/config.py | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/dts/api/testpmd/config.py b/dts/api/testpmd/config.py
index e71a3e1ef0..1e59bccd08 100644
--- a/dts/api/testpmd/config.py
+++ b/dts/api/testpmd/config.py
@@ -30,7 +30,8 @@
 class PortTopology(StrEnum):
     """Enum representing the port topology."""
 
-    #: In paired mode, the forwarding is between pairs of ports, e.g.: (0,1), (2,3), (4,5).
+    #: In paired mode, the forwarding is between pairs of ports, e.g.:
+    #: (0,1), (2,3), (4,5).
     paired = auto()
 
     #: In chained mode, the forwarding is to the next available port in the port mask, e.g.:
-- 
2.53.0

Re: [PATCH] dts: fix Sphinx parsing of a docstring

[Patrick Robb]

[-- Attachment #1: Type: text/plain, Size: 1306 bytes --]

Thanks Thomas for fixing this.

I had done a manual doc build (and checked the doc builds from CI) before
merging patches to next-dts, so I suppose my Sphinx version must be less
than 9.1.0. I can check this when I do my next doc build.

On Tue, Mar 31, 2026 at 12:13 PM Thomas Monjalon <thomas@monjalon.net>
wrote:

> With Sphinx 9.1.0, the word "ports" is wrongly parsed as a reference,
> and the doc fails to generate.
> Splitting the docstring (as the next one) seems to be a workaround.
>
> Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
> ---
>  dts/api/testpmd/config.py | 3 ++-
>  1 file changed, 2 insertions(+), 1 deletion(-)
>
> diff --git a/dts/api/testpmd/config.py b/dts/api/testpmd/config.py
> index e71a3e1ef0..1e59bccd08 100644
> --- a/dts/api/testpmd/config.py
> +++ b/dts/api/testpmd/config.py
> @@ -30,7 +30,8 @@
>  class PortTopology(StrEnum):
>      """Enum representing the port topology."""
>
> -    #: In paired mode, the forwarding is between pairs of ports, e.g.:
> (0,1), (2,3), (4,5).
> +    #: In paired mode, the forwarding is between pairs of ports, e.g.:
> +    #: (0,1), (2,3), (4,5).
>      paired = auto()
>
>      #: In chained mode, the forwarding is to the next available port in
> the port mask, e.g.:
> --
> 2.53.0
>
>

[-- Attachment #2: Type: text/html, Size: 1792 bytes --]

Re: [PATCH] dts: fix Sphinx parsing of a docstring

[Thomas Monjalon]

It was working for me as well until I update my distro...


31/03/2026 18:13, Patrick Robb:
> Thanks Thomas for fixing this.
> 
> I had done a manual doc build (and checked the doc builds from CI) before
> merging patches to next-dts, so I suppose my Sphinx version must be less
> than 9.1.0. I can check this when I do my next doc build.
> 
> On Tue, Mar 31, 2026 at 12:13 PM Thomas Monjalon <thomas@monjalon.net>
> wrote:
> 
> > With Sphinx 9.1.0, the word "ports" is wrongly parsed as a reference,
> > and the doc fails to generate.
> > Splitting the docstring (as the next one) seems to be a workaround.
> >
> > Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
> > ---
> >  dts/api/testpmd/config.py | 3 ++-
> >  1 file changed, 2 insertions(+), 1 deletion(-)
> >
> > diff --git a/dts/api/testpmd/config.py b/dts/api/testpmd/config.py
> > index e71a3e1ef0..1e59bccd08 100644
> > --- a/dts/api/testpmd/config.py
> > +++ b/dts/api/testpmd/config.py
> > @@ -30,7 +30,8 @@
> >  class PortTopology(StrEnum):
> >      """Enum representing the port topology."""
> >
> > -    #: In paired mode, the forwarding is between pairs of ports, e.g.:
> > (0,1), (2,3), (4,5).
> > +    #: In paired mode, the forwarding is between pairs of ports, e.g.:
> > +    #: (0,1), (2,3), (4,5).
> >      paired = auto()
> >
> >      #: In chained mode, the forwarding is to the next available port in
> > the port mask, e.g.:
> > --
> > 2.53.0
> >
> >
>