From: Thomas Monjalon <thomas@monjalon.net>
To: dev@dpdk.org
Cc: Luca Vizzarro <luca.vizzarro@arm.com>, Patrick Robb <probb@iol.unh.edu>
Subject: [PATCH] dts: fix Sphinx parsing of a docstring
Date: Tue, 31 Mar 2026 18:12:52 +0200 [thread overview]
Message-ID: <20260331161253.462180-1-thomas@monjalon.net> (raw)
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
next reply other threads:[~2026-03-31 16:13 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-03-31 16:12 Thomas Monjalon [this message]
2026-03-31 16:13 ` [PATCH] dts: fix Sphinx parsing of a docstring Patrick Robb
2026-03-31 16:38 ` Thomas Monjalon
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=20260331161253.462180-1-thomas@monjalon.net \
--to=thomas@monjalon.net \
--cc=dev@dpdk.org \
--cc=luca.vizzarro@arm.com \
--cc=probb@iol.unh.edu \
/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