Browse Source

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>
pull/291/head
John Snow 1 year ago
committed by Markus Armbruster
parent
commit
a6af544344
  1. 2
      docs/conf.py
  2. 2
      docs/interop/qemu-ga-ref.rst
  3. 2
      docs/interop/qemu-storage-daemon-qmp-ref.rst
  4. 3
      qga/qapi-schema.json
  5. 8
      storage-daemon/qapi/qapi-schema.json

2
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 ----------------------------------------------

2
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

2
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

3
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 } }

8
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

Loading…
Cancel
Save