docs: enable qapidoc transmogrifier for QEMU QMP Reference

jnsnow · Markus Armbruster · commit a377f39f38fe · 2025-03-11T10:26:52.000+01:00
We are not enabling the transmogrifier for QSD or QGA yet because we
don't (yet) have a way to create separate indices, and all of the
definitions will bleed together, which isn't so nice.

For now, QMP is better than nothing at all!

Signed-off-by: John Snow &lt;jsnow@redhat.com&gt;
Message-ID: &lt;20250311034303.75779-62-jsnow@redhat.com&gt;
Acked-by: Markus Armbruster &lt;armbru@redhat.com&gt;
Signed-off-by: Markus Armbruster &lt;armbru@redhat.com&gt;
diff --git a/docs/interop/qemu-qmp-ref.rst b/docs/interop/qemu-qmp-ref.rst
@@ -7,3 +7,4 @@ QEMU QMP Reference Manual
    :depth: 3
 
 .. qapi-doc:: qapi/qapi-schema.json
+   :transmogrify:
diff --git a/qapi/qapi-schema.json b/qapi/qapi-schema.json
@@ -5,6 +5,8 @@
 #
 # This document describes all commands currently supported by QMP.
 #
+# For locating a particular item, please see the `qapi-index`.
+#
 # Most of the time their usage is exactly the same as in the user
 # Monitor, this means that any other document which also describe
 # commands (the manpage, QEMU's manual, etc) can and should be

Original file line number	Diff line number	Diff line change
`@@ -7,3 +7,4 @@ QEMU QMP Reference Manual`
`7`	`7`	`:depth: 3`
`8`	`8`
`9`	`9`	`.. qapi-doc:: qapi/qapi-schema.json`
	`10`	`+ :transmogrify:`
Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,8 @@`
`5`	`5`	`#`
`6`	`6`	`# This document describes all commands currently supported by QMP.`
`7`	`7`	`#`
	`8`	+# For locating a particular item, please see the `qapi-index`.
	`9`	`+#`
`8`	`10`	`# Most of the time their usage is exactly the same as in the user`
`9`	`11`	`# Monitor, this means that any other document which also describe`
`10`	`12`	`# commands (the manpage, QEMU's manual, etc) can and should be`