]> git.ipfire.org Git - thirdparty/qemu.git/commit
docs/qapi-domain: add namespaced index support
authorJohn Snow <jsnow@redhat.com>
Thu, 13 Mar 2025 04:43:09 +0000 (00:43 -0400)
committerMarkus Armbruster <armbru@redhat.com>
Fri, 14 Mar 2025 06:32:41 +0000 (07:32 +0100)
commit25d44f57e17b088fdc4e38042e04c4e9da2c1088
treedc13a8db516ab9c34aea9002809920b4d87aa2ac
parent7127e14f15fc52b436eb63e482a9f117bd4346d2
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>
docs/conf.py
docs/sphinx/qapi_domain.py