From 2e51072ae5c0275733be748fbee3ce59df6d6261 Mon Sep 17 00:00:00 2001 From: John Snow Date: Fri, 11 Jul 2025 01:10:42 -0400 Subject: docs/qapi-domain: add return-nodesc This form is used to annotate a return type without an accompanying description, for when there is no "Returns:" information in the source doc, but we have a return type we want to generate a cross-reference to. The syntax is: :return-nodesc: TypeName It's primarily necessary because Sphinx always expects both a type and a description for the prior form and will format it accordingly. To have a reasonable rendering when the body is missing, we need to use a different info field list entirely. Signed-off-by: John Snow Message-ID: <20250711051045.51110-2-jsnow@redhat.com> Acked-by: Markus Armbruster [Long line wrapped] Signed-off-by: Markus Armbruster --- docs/sphinx/qapi_domain.py | 8 ++++++++ 1 file changed, 8 insertions(+) (limited to 'docs/sphinx/qapi_domain.py') diff --git a/docs/sphinx/qapi_domain.py b/docs/sphinx/qapi_domain.py index ebc46a72c6..f561dc465f 100644 --- a/docs/sphinx/qapi_domain.py +++ b/docs/sphinx/qapi_domain.py @@ -532,6 +532,14 @@ class QAPICommand(QAPIObject): names=("return",), can_collapse=True, ), + # :return-nodesc: TypeName + CompatField( + "returnvalue", + label=_("Return"), + names=("return-nodesc",), + bodyrolename="type", + has_arg=False, + ), ] ) -- cgit 1.4.1