qemu/docs/sphinx
John Snow 902c9b0e34 docs/qapi-domain: add qapi:enum directive
Add the .. qapi:enum:: directive, object, and :qapi:enum:`name`
cross-reference role.

Add the :value name: field list for documenting Enum values.

Of note, also introduce a new "type" role that is intended to be used by
other QAPI object directives to cross-reference arbitrary QAPI type
names, but will exclude commands, events, and modules from
consideration.

Signed-off-by: John Snow <jsnow@redhat.com>
Message-ID: <20250311034303.75779-20-jsnow@redhat.com>
Acked-by: Markus Armbruster <armbru@redhat.com>
Signed-off-by: Markus Armbruster <armbru@redhat.com>
2025-03-11 10:10:56 +01:00
..
compat.py docs/qapi-domain: add compatibility node classes 2025-03-11 10:07:03 +01:00
dbusdoc.py docs/sphinx: add sphinx modules to include D-Bus documentation 2021-12-21 10:50:21 +04:00
dbusdomain.py meson: Pass -j option to sphinx 2023-05-18 08:53:50 +02:00
dbusparser.py docs/sphinx: add sphinx modules to include D-Bus documentation 2021-12-21 10:50:21 +04:00
depfile.py docs/sphinx: include kernel-doc script as a dependency 2025-01-17 10:45:38 +00:00
fakedbusdoc.py meson: Pass -j option to sphinx 2023-05-18 08:53:50 +02:00
hxtool.py docs: remove Sphinx 1.x compatibility code 2024-07-12 16:46:21 -04:00
kerneldoc.py docs: remove Sphinx 1.x compatibility code 2024-07-12 16:46:21 -04:00
qapi_domain.py docs/qapi-domain: add qapi:enum directive 2025-03-11 10:10:56 +01:00
qapidoc.py docs/qapidoc: remove example section support 2025-03-04 07:11:06 +01:00
qmp_lexer.py meson: Pass -j option to sphinx 2023-05-18 08:53:50 +02:00