mirrors/qemu
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: add table of contents to QAPI references

Browse Source 
The QAPI reference docs for the guest agent, storage daemon and QMP are
all rather long and hard to navigate unless you already know the name of
the command and can do full text search for it.

A table of contents in each doc will help people locate stuff much more
easily.

Reviewed-by: Connor Kuehl <ckuehl@redhat.com>
Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
This commit is contained in:
Daniel P. Berrangé 2021-05-11 10:23:52 +01:00
parent 894fc4fd67
commit e0bd0cd43e
3 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
docs/interop/qemu-ga-ref.rst
View File

@ -10,4 +10,7 @@ QEMU Guest Agent Protocol Reference
TODO: display the QEMU version, both here and in our Sphinx manuals TODO: display the QEMU version, both here and in our Sphinx manuals
more generally. more generally.
.. contents::
:depth: 3
.. qapi-doc:: qga/qapi-schema.json .. qapi-doc:: qga/qapi-schema.json

3
docs/interop/qemu-qmp-ref.rst
View File

@ -10,4 +10,7 @@ QEMU QMP Reference Manual
TODO: display the QEMU version, both here and in our Sphinx manuals TODO: display the QEMU version, both here and in our Sphinx manuals
more generally. more generally.
.. contents::
:depth: 3
.. qapi-doc:: qapi/qapi-schema.json .. qapi-doc:: qapi/qapi-schema.json

3
docs/interop/qemu-storage-daemon-qmp-ref.rst
View File

@ -10,4 +10,7 @@ QEMU Storage Daemon QMP Reference Manual
TODO: display the QEMU version, both here and in our Sphinx manuals TODO: display the QEMU version, both here and in our Sphinx manuals
more generally. more generally.
.. contents::
:depth: 3
.. qapi-doc:: storage-daemon/qapi/qapi-schema.json .. qapi-doc:: storage-daemon/qapi/qapi-schema.json