diff options
| author | Peter Maydell <peter.maydell@linaro.org> | 2019-03-07 15:21:54 +0000 |
|---|---|---|
| committer | Peter Maydell <peter.maydell@linaro.org> | 2019-03-07 15:21:54 +0000 |
| commit | 21afe115a49776aa07f4d93d22b9ad133fd183a5 (patch) | |
| tree | 06c13402442f44873748d983cf1d56b28bcac405 /docs/interop | |
| parent | 3a75ef6a0fe397b0d36930415be6b123750a6afe (diff) | |
| parent | c10e01b996df09f6cb4eceb2b7a9754bece927c9 (diff) | |
| download | qemu-21afe115a49776aa07f4d93d22b9ad133fd183a5.zip qemu-21afe115a49776aa07f4d93d22b9ad133fd183a5.tar.gz qemu-21afe115a49776aa07f4d93d22b9ad133fd183a5.tar.bz2 | |
Merge remote-tracking branch 'remotes/pmaydell/tags/pull-sphinx-20190307' into staging
Enable building and installing rST docs with Sphinx
# gpg: Signature made Thu 07 Mar 2019 15:05:12 GMT
# gpg: using RSA key E1A5C593CD419DE28E8315CF3C2525ED14360CDE
# gpg: issuer "peter.maydell@linaro.org"
# gpg: Good signature from "Peter Maydell <peter.maydell@linaro.org>" [ultimate]
# gpg: aka "Peter Maydell <pmaydell@gmail.com>" [ultimate]
# gpg: aka "Peter Maydell <pmaydell@chiark.greenend.org.uk>" [ultimate]
# Primary key fingerprint: E1A5 C593 CD41 9DE2 8E83 15CF 3C25 25ED 1436 0CDE
* remotes/pmaydell/tags/pull-sphinx-20190307:
MAINTAINERS: Add entry for Sphinx documentation infrastructure
docs/conf.py: Don't hard-code QEMU version
Makefile: Abstract out "identify the pkgversion" code
Makefile, configure: Support building rST documentation
docs: Provide separate conf.py for each manual we want
docs/conf.py: Disable option warnings
docs/conf.py: Don't include rST sources in HTML build
docs/conf.py: Configure the 'alabaster' theme
docs/conf.py: Disable unused _static directory
docs: Commit initial files from sphinx-quickstart
docs: Convert memory.txt to rst format
docs/cpu-hotplug.rst: Fix rST markup issues
Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
Diffstat (limited to 'docs/interop')
| -rw-r--r-- | docs/interop/conf.py | 15 | ||||
| -rw-r--r-- | docs/interop/index.rst | 18 |
2 files changed, 33 insertions, 0 deletions
diff --git a/docs/interop/conf.py b/docs/interop/conf.py new file mode 100644 index 0000000..cf3c69d --- /dev/null +++ b/docs/interop/conf.py @@ -0,0 +1,15 @@ +# -*- coding: utf-8 -*- +# +# QEMU documentation build configuration file for the 'interop' manual. +# +# This includes the top level conf file and then makes any necessary tweaks. +import sys +import os + +qemu_docdir = os.path.abspath("..") +parent_config = os.path.join(qemu_docdir, "conf.py") +exec(compile(open(parent_config, "rb").read(), parent_config, 'exec')) + +# This slightly misuses the 'description', but is the best way to get +# the manual title to appear in the sidebar. +html_theme_options['description'] = u'System Emulation Management and Interoperability Guide' diff --git a/docs/interop/index.rst b/docs/interop/index.rst new file mode 100644 index 0000000..2df977d --- /dev/null +++ b/docs/interop/index.rst @@ -0,0 +1,18 @@ +.. This is the top level page for the 'interop' manual. + + +QEMU System Emulation Management and Interoperability Guide +=========================================================== + +This manual contains documents and specifications that are useful +for making QEMU interoperate with other software. + +Contents: + +.. toctree:: + :maxdepth: 2 + + bitmaps + live-block-operations + pr-helper + |