[PATCH] dts: fix Sphinx parsing of a docstring
Thomas Monjalon
thomas at monjalon.net
Tue Mar 31 18:12:52 CEST 2026
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
More information about the dev
mailing list