summary refs log tree commit diff stats
diff options
context:
space:
mode:
authorJohn Snow <jsnow@redhat.com>2025-03-13 00:43:10 -0400
committerMarkus Armbruster <armbru@redhat.com>2025-03-14 07:32:41 +0100
commit602c90beaedd9abbbf1535c8630293267e6b29c0 (patch)
tree933c10bfd5c740e483f978f032236a8405789465
parent25d44f57e17b088fdc4e38042e04c4e9da2c1088 (diff)
downloadfocaccia-qemu-602c90beaedd9abbbf1535c8630293267e6b29c0.tar.gz
focaccia-qemu-602c90beaedd9abbbf1535c8630293267e6b29c0.zip
docs: add QAPI namespace "QMP" to qemu-qmp-ref
This also creates the qapi-qmp-index.html index and cross-reference
target.

Signed-off-by: John Snow <jsnow@redhat.com>
Message-ID: <20250313044312.189276-10-jsnow@redhat.com>
Acked-by: Markus Armbruster <armbru@redhat.com>
Signed-off-by: Markus Armbruster <armbru@redhat.com>
-rw-r--r--docs/conf.py4
-rw-r--r--docs/interop/qemu-qmp-ref.rst1
-rw-r--r--qapi/qapi-schema.json2
3 files changed, 5 insertions, 2 deletions
diff --git a/docs/conf.py b/docs/conf.py
index 175491148c..9a86e84a80 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -163,7 +163,9 @@ qapi_allowed_fields = {
 
 # 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
index e95eeac45e..ef8792b53f 100644
--- 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
index 4475e81cc3..c41c01eb2a 100644
--- 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