From 0928523a1230a690c933cee6e353e06b0810c7c6 Mon Sep 17 00:00:00 2001 From: Peter Maydell Date: Thu, 23 Jan 2020 15:22:40 +0000 Subject: 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 Reviewed-by: Alex Bennée Acked-by: Stefan Hajnoczi Message-id: 20200116141511.16849-3-peter.maydell@linaro.org --- docs/system/conf.py | 15 +++++++++++++++ docs/system/index.rst | 16 ++++++++++++++++ 2 files changed, 31 insertions(+) create mode 100644 docs/system/conf.py create mode 100644 docs/system/index.rst (limited to 'docs/system') 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 + -- cgit v1.2.3-55-g7522