[PATCH] dts: fix Sphinx parsing of a docstring
Patrick Robb
probb at iol.unh.edu
Tue Mar 31 18:13:26 CEST 2026
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 at 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 at 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
>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mails.dpdk.org/archives/dev/attachments/20260331/b0be1436/attachment.htm>
More information about the dev
mailing list