diff options
| author | Peter Maydell <peter.maydell@linaro.org> | 2020-09-25 17:23:02 +0100 |
|---|---|---|
| committer | Markus Armbruster <armbru@redhat.com> | 2020-09-29 17:55:39 +0200 |
| commit | 4078ee5469e5e35a65babb1a52cbed597b505ba2 (patch) | |
| tree | af01fbea1b42e04509d1460c784f97d290acf26d /docs/conf.py | |
| parent | 44e12af7754b60c0c80c52e63422f33d92127929 (diff) | |
| download | qemu-4078ee5469e5e35a65babb1a52cbed597b505ba2.zip qemu-4078ee5469e5e35a65babb1a52cbed597b505ba2.tar.gz qemu-4078ee5469e5e35a65babb1a52cbed597b505ba2.tar.bz2 | |
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 'docs/conf.py')
| -rw-r--r-- | docs/conf.py | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/docs/conf.py b/docs/conf.py index 0dbd90d..606f623 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -52,7 +52,10 @@ except NameError: # add these directories to sys.path here. If the directory is relative to the # documentation root, use an absolute path starting from qemu_docdir. # +# Our extensions are in docs/sphinx; the qapidoc extension requires +# the QAPI modules from scripts/. sys.path.insert(0, os.path.join(qemu_docdir, "sphinx")) +sys.path.insert(0, os.path.join(qemu_docdir, "../scripts")) # -- General configuration ------------------------------------------------ @@ -67,7 +70,7 @@ needs_sphinx = '1.6' # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. -extensions = ['kerneldoc', 'qmp_lexer', 'hxtool', 'depfile'] +extensions = ['kerneldoc', 'qmp_lexer', 'hxtool', 'depfile', 'qapidoc'] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -241,3 +244,4 @@ texinfo_documents = [ kerneldoc_bin = os.path.join(qemu_docdir, '../scripts/kernel-doc') kerneldoc_srctree = os.path.join(qemu_docdir, '..') hxtool_srctree = os.path.join(qemu_docdir, '..') +qapidoc_srctree = os.path.join(qemu_docdir, '..') |