diff options
| author | John Snow <jsnow@redhat.com> | 2025-03-13 00:43:12 -0400 |
|---|---|---|
| committer | Markus Armbruster <armbru@redhat.com> | 2025-03-14 07:32:41 +0100 |
| commit | a6af54434400099b8afd59ba036cf9a662006d1e (patch) | |
| tree | 1731d2e51996ec21c0d0907d85cc8dbcbee552e6 | |
| parent | d85f7efe1f16c51b9c016ebc79f7c4081486642e (diff) | |
| download | qemu-a6af54434400099b8afd59ba036cf9a662006d1e.zip qemu-a6af54434400099b8afd59ba036cf9a662006d1e.tar.gz qemu-a6af54434400099b8afd59ba036cf9a662006d1e.tar.bz2 | |
docs: enable transmogrifier for QSD and QGA
This also creates the `qapi-qsd-index` and `qapi-qga-index` QMP indices.
Signed-off-by: John Snow <jsnow@redhat.com>
Message-ID: <20250313044312.189276-12-jsnow@redhat.com>
Acked-by: Markus Armbruster <armbru@redhat.com>
Signed-off-by: Markus Armbruster <armbru@redhat.com>
| -rw-r--r-- | docs/conf.py | 2 | ||||
| -rw-r--r-- | docs/interop/qemu-ga-ref.rst | 2 | ||||
| -rw-r--r-- | docs/interop/qemu-storage-daemon-qmp-ref.rst | 2 | ||||
| -rw-r--r-- | qga/qapi-schema.json | 3 | ||||
| -rw-r--r-- | storage-daemon/qapi/qapi-schema.json | 8 |
5 files changed, 17 insertions, 0 deletions
diff --git a/docs/conf.py b/docs/conf.py index 9a86e84..7b5712e 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -164,7 +164,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 = { + "QGA", "QMP", + "QSD", } # -- Options for HTML output ---------------------------------------------- diff --git a/docs/interop/qemu-ga-ref.rst b/docs/interop/qemu-ga-ref.rst index 032d492..19b5c7a 100644 --- a/docs/interop/qemu-ga-ref.rst +++ b/docs/interop/qemu-ga-ref.rst @@ -5,3 +5,5 @@ QEMU Guest Agent Protocol Reference :depth: 3 .. qapi-doc:: qga/qapi-schema.json + :transmogrify: + :namespace: QGA diff --git a/docs/interop/qemu-storage-daemon-qmp-ref.rst b/docs/interop/qemu-storage-daemon-qmp-ref.rst index 9fed681..d0228d6 100644 --- a/docs/interop/qemu-storage-daemon-qmp-ref.rst +++ b/docs/interop/qemu-storage-daemon-qmp-ref.rst @@ -5,3 +5,5 @@ QEMU Storage Daemon QMP Reference Manual :depth: 3 .. qapi-doc:: storage-daemon/qapi/qapi-schema.json + :transmogrify: + :namespace: QSD diff --git a/qga/qapi-schema.json b/qga/qapi-schema.json index 995594a..35ec0e7 100644 --- a/qga/qapi-schema.json +++ b/qga/qapi-schema.json @@ -3,6 +3,9 @@ ## # = QEMU guest agent protocol commands and structs +# +# For a concise listing of all commands, events, and types in the QEMU +# guest agent, please consult the `qapi-qga-index`. ## { 'pragma': { 'doc-required': true } } diff --git a/storage-daemon/qapi/qapi-schema.json b/storage-daemon/qapi/qapi-schema.json index f10c949..2a562ee 100644 --- a/storage-daemon/qapi/qapi-schema.json +++ b/storage-daemon/qapi/qapi-schema.json @@ -13,6 +13,14 @@ # the array type in the main schema, even if it is unused outside of the # storage daemon. +## +# = QEMU storage daemon protocol commands and structs +# +# For a concise listing of all commands, events, and types in the QEMU +# storage daemon, please consult the `qapi-qsd-index`. +## + + { 'include': '../../qapi/pragma.json' } # Documentation generated with qapi-gen.py is in source order, with |