docs: add QAPI namespace "QMP" to qemu-qmp-ref

jnsnow · Markus Armbruster · commit 602c90beaedd · 2025-03-14T07:32:41.000+01:00
This also creates the qapi-qmp-index.html index and cross-reference
target.

Signed-off-by: John Snow &lt;jsnow@redhat.com&gt;
Message-ID: &lt;20250313044312.189276-10-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/conf.py b/docs/conf.py
@@ -163,7 +163,9 @@
 
 # Due to a limitation in Sphinx, we need to know which indices to
 # generate in advance. Adding a namespace here allows that generation.
-qapi_namespaces = set()
+qapi_namespaces = {
+    "QMP",
+}
 
 # -- Options for HTML output ----------------------------------------------
 
diff --git a/docs/interop/qemu-qmp-ref.rst b/docs/interop/qemu-qmp-ref.rst
@@ -8,3 +8,4 @@ QEMU QMP Reference Manual
 
 .. qapi-doc:: qapi/qapi-schema.json
    :transmogrify:
+   :namespace: QMP
diff --git a/qapi/qapi-schema.json b/qapi/qapi-schema.json
@@ -5,7 +5,7 @@
 #
 # This document describes all commands currently supported by QMP.
 #
-# For locating a particular item, please see the `qapi-index`.
+# For locating a particular item, please see the `qapi-qmp-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

Original file line number	Diff line number	Diff line change
`@@ -8,3 +8,4 @@ QEMU QMP Reference Manual`
`8`	`8`
`9`	`9`	`.. qapi-doc:: qapi/qapi-schema.json`
`10`	`10`	`:transmogrify:`
	`11`	`+ :namespace: QMP`
Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@`
`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`.
	`8`	+# For locating a particular item, please see the `qapi-qmp-index`.
`9`	`9`	`#`
`10`	`10`	`# Most of the time their usage is exactly the same as in the user`
`11`	`11`	`# Monitor, this means that any other document which also describe`