qemu/docs/sphinx
John Snow 25d44f57e1 docs/qapi-domain: add namespaced index support
Generate an index-per-namespace for the QAPI domain. Due to a limitation
with Sphinx's architecture, these indices must be defined during setup
time and cannot be dynamically created on-demand when a namespace
directive is encountered.

Owing to that limitation, add a configuration value to conf.py that
specifies which QAPI namespaces we'll generate indices for.

Indices will be named after their namespace, e.g. the "QMP" namespace
will generate to "qapi-qmp-index.html" and can be referenced using
`qapi-qmp-index`.

Signed-off-by: John Snow <jsnow@redhat.com>
Message-ID: <20250313044312.189276-9-jsnow@redhat.com>
Acked-by: Markus Armbruster <armbru@redhat.com>
Signed-off-by: Markus Armbruster <armbru@redhat.com>
2025-03-14 07:32:41 +01:00
..
compat.py docs/qapi-domain: Fix error context reporting in Sphinx 5.x and 6.x 2025-03-11 10:10:57 +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 namespaced index support 2025-03-14 07:32:41 +01:00
qapidoc.py docs/qapidoc: add :namespace: option to qapi-doc directive 2025-03-14 07:31:57 +01:00
qapidoc_legacy.py docs/qapidoc: Fix static typing on qapidoc.py 2025-03-11 10:10:57 +01:00
qmp_lexer.py meson: Pass -j option to sphinx 2023-05-18 08:53:50 +02:00