]> git.proxmox.com Git - mirror_qemu.git/commit - MAINTAINERS
docs/sphinx: Add new qapi-doc Sphinx extension
authorPeter Maydell <peter.maydell@linaro.org>
Fri, 25 Sep 2020 16:23:02 +0000 (17:23 +0100)
committerMarkus Armbruster <armbru@redhat.com>
Tue, 29 Sep 2020 15:55:39 +0000 (17:55 +0200)
commit4078ee5469e5e35a65babb1a52cbed597b505ba2
treeaf01fbea1b42e04509d1460c784f97d290acf26d
parent44e12af7754b60c0c80c52e63422f33d92127929
docs/sphinx: Add new qapi-doc Sphinx extension

Some of our documentation is auto-generated from documentation
comments in the JSON schema.

For Sphinx, rather than creating a file to include, the most natural
way to handle this is to have a small custom Sphinx extension which
processes the JSON file and inserts documentation into the rST
file being processed.

This is the same approach that kerneldoc and hxtool use.

Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
Message-Id: <20200925162316.21205-8-peter.maydell@linaro.org>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
[Comment and doc string formatting tweaked, unused method dropped,
a few line breaks tweaked to follow PEP 8 more closely, MAINTAINERS
section QAPI updated]
Signed-off-by: Markus Armbruster <armbru@redhat.com>
MAINTAINERS
docs/conf.py
docs/sphinx/qapidoc.py [new file with mode: 0644]