diff options
| author | Peter Maydell | 2020-09-25 18:23:02 +0200 |
|---|---|---|
| committer | Markus Armbruster | 2020-09-29 17:55:39 +0200 |
| commit | 4078ee5469e5e35a65babb1a52cbed597b505ba2 (patch) | |
| tree | af01fbea1b42e04509d1460c784f97d290acf26d /MAINTAINERS | |
| parent | qapi/machine.json: Escape a literal '*' in doc comment (diff) | |
| download | qemu-4078ee5469e5e35a65babb1a52cbed597b505ba2.tar.gz qemu-4078ee5469e5e35a65babb1a52cbed597b505ba2.tar.xz qemu-4078ee5469e5e35a65babb1a52cbed597b505ba2.zip | |
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>
Diffstat (limited to 'MAINTAINERS')
| -rw-r--r-- | MAINTAINERS | 2 |
1 files changed, 2 insertions, 0 deletions
diff --git a/MAINTAINERS b/MAINTAINERS index be0a8e648c..ac3e4e465c 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -2387,6 +2387,7 @@ F: tests/test-qmp-*.c F: tests/test-visitor-serialization.c F: scripts/qapi-gen.py F: scripts/qapi/* +F: docs/sphinx/qapidoc.py F: docs/devel/qapi* T: git https://repo.or.cz/qemu/armbru.git qapi-next @@ -3151,6 +3152,7 @@ M: Peter Maydell <peter.maydell@linaro.org> S: Maintained F: docs/conf.py F: docs/*/conf.py +F: docs/sphinx/ Miscellaneous ------------- |