* [PATCH] docs: add table of contents to QAPI references
@ 2021-05-11 9:25 Daniel P. Berrangé
2021-05-11 19:15 ` Connor Kuehl
0 siblings, 1 reply; 2+ messages in thread
From: Daniel P. Berrangé @ 2021-05-11 9:25 UTC (permalink / raw)
To: qemu-devel
Cc: Kevin Wolf, Michael Roth, Daniel P. Berrangé,
Markus Armbruster, qemu-block
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.
Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
---
docs/interop/qemu-ga-ref.rst | 3 +++
docs/interop/qemu-qmp-ref.rst | 3 +++
docs/interop/qemu-storage-daemon-qmp-ref.rst | 3 +++
3 files changed, 9 insertions(+)
diff --git a/docs/interop/qemu-ga-ref.rst b/docs/interop/qemu-ga-ref.rst
index 3f1c4f908f..db1e946124 100644
--- a/docs/interop/qemu-ga-ref.rst
+++ b/docs/interop/qemu-ga-ref.rst
@@ -10,4 +10,7 @@ QEMU Guest Agent Protocol Reference
TODO: display the QEMU version, both here and in our Sphinx manuals
more generally.
+.. contents::
+ :depth: 3
+
.. qapi-doc:: qga/qapi-schema.json
diff --git a/docs/interop/qemu-qmp-ref.rst b/docs/interop/qemu-qmp-ref.rst
index c8abaaf8e3..b5bebf6b9a 100644
--- a/docs/interop/qemu-qmp-ref.rst
+++ b/docs/interop/qemu-qmp-ref.rst
@@ -10,4 +10,7 @@ QEMU QMP Reference Manual
TODO: display the QEMU version, both here and in our Sphinx manuals
more generally.
+.. contents::
+ :depth: 3
+
.. qapi-doc:: qapi/qapi-schema.json
diff --git a/docs/interop/qemu-storage-daemon-qmp-ref.rst b/docs/interop/qemu-storage-daemon-qmp-ref.rst
index caf9dad23a..d0ebb42ebd 100644
--- a/docs/interop/qemu-storage-daemon-qmp-ref.rst
+++ b/docs/interop/qemu-storage-daemon-qmp-ref.rst
@@ -10,4 +10,7 @@ QEMU Storage Daemon QMP Reference Manual
TODO: display the QEMU version, both here and in our Sphinx manuals
more generally.
+.. contents::
+ :depth: 3
+
.. qapi-doc:: storage-daemon/qapi/qapi-schema.json
--
2.31.1
^ permalink raw reply related [flat|nested] 2+ messages in thread
* Re: [PATCH] docs: add table of contents to QAPI references
2021-05-11 9:25 [PATCH] docs: add table of contents to QAPI references Daniel P. Berrangé
@ 2021-05-11 19:15 ` Connor Kuehl
0 siblings, 0 replies; 2+ messages in thread
From: Connor Kuehl @ 2021-05-11 19:15 UTC (permalink / raw)
To: Daniel P. Berrangé, qemu-devel
Cc: Kevin Wolf, Michael Roth, Markus Armbruster, qemu-block
On 5/11/21 4:25 AM, Daniel P. Berrangé wrote:
> 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.
>
> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
> ---
This looks so much better!
Reviewed-by: Connor Kuehl <ckuehl@redhat.com>
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2021-05-11 19:17 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-05-11 9:25 [PATCH] docs: add table of contents to QAPI references Daniel P. Berrangé
2021-05-11 19:15 ` Connor Kuehl
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).