diff options
| author | John Snow <jsnow@redhat.com> | 2025-03-10 23:42:13 -0400 |
|---|---|---|
| committer | Markus Armbruster <armbru@redhat.com> | 2025-03-11 10:10:48 +0100 |
| commit | 618379701b4127877d858aa6a792c8a329ec48bc (patch) | |
| tree | a5e06193bfc827924e05bbabccba7ba5a6b3812c /rust/qemu-api | |
| parent | 700d51a45c614068393f9754d3ef366e2c05a884 (diff) | |
| download | qemu-618379701b4127877d858aa6a792c8a329ec48bc.zip qemu-618379701b4127877d858aa6a792c8a329ec48bc.tar.gz qemu-618379701b4127877d858aa6a792c8a329ec48bc.tar.bz2 | |
docs/qapi-domain: add "Arguments:" field lists
This adds special rendering for Sphinx's typed info field lists.
This patch does not add any QAPI-aware markup, rendering, or
cross-referencing for the type names, yet. That feature requires a
subclass to TypedField which will happen in its own commit quite a bit
later in this series; after all the basic fields and objects have been
established first.
The syntax for this field is:
:arg type name: description
description cont'd
You can omit the type or the description. You should not omit the name;
if you do so, it degenerates into a "normal field list" entry, and
probably isn't what you want.
Signed-off-by: John Snow <jsnow@redhat.com>
Message-ID: <20250311034303.75779-16-jsnow@redhat.com>
Acked-by: Markus Armbruster <armbru@redhat.com>
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Diffstat (limited to 'rust/qemu-api')
0 files changed, 0 insertions, 0 deletions