diff options
| author | Peter Maydell <peter.maydell@linaro.org> | 2020-01-23 15:22:40 +0000 |
|---|---|---|
| committer | Peter Maydell <peter.maydell@linaro.org> | 2020-01-23 15:22:40 +0000 |
| commit | 0928523a1230a690c933cee6e353e06b0810c7c6 (patch) | |
| tree | 9675f5af8f49403718537cadc42428cbfae9a927 /docs/system | |
| parent | 87c0868f467db84df930fe687241d9cc2bfd1dd2 (diff) | |
docs: Create stub system manual
We want a user-facing manual which contains system emulation
documentation. Create an empty one which we can populate.
Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
Reviewed-by: Alex Bennée <alex.bennee@linaro.org>
Acked-by: Stefan Hajnoczi <stefanha@redhat.com>
Message-id: 20200116141511.16849-3-peter.maydell@linaro.org
Diffstat (limited to 'docs/system')
| -rw-r--r-- | docs/system/conf.py | 15 | ||||
| -rw-r--r-- | docs/system/index.rst | 16 |
2 files changed, 31 insertions, 0 deletions
diff --git a/docs/system/conf.py b/docs/system/conf.py new file mode 100644 index 0000000000..6435b4d3f8 --- /dev/null +++ b/docs/system/conf.py @@ -0,0 +1,15 @@ +# -*- coding: utf-8 -*- +# +# QEMU documentation build configuration file for the 'system' 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 User''s Guide' diff --git a/docs/system/index.rst b/docs/system/index.rst new file mode 100644 index 0000000000..ea8ea5fe3d --- /dev/null +++ b/docs/system/index.rst @@ -0,0 +1,16 @@ +.. This is the top level page for the 'system' manual. + + +QEMU System Emulation User's Guide +================================== + +This manual is the overall guide for users using QEMU +for full system emulation (as opposed to user-mode emulation). +This includes working with hypervisors such as KVM, Xen, Hax +or Hypervisor.Framework. + +Contents: + +.. toctree:: + :maxdepth: 2 + |