aboutsummaryrefslogtreecommitdiff
path: root/docs/user/conf.py
diff options
context:
space:
mode:
authorPaolo Bonzini <pbonzini@redhat.com>2020-02-28 15:35:47 +0000
committerPeter Maydell <peter.maydell@linaro.org>2020-03-06 10:04:57 +0000
commit091479301f96d0e1df0ab12f18d1b265979cba47 (patch)
treef518e7b1ce0177459d8d54b41fe11e852ee39889 /docs/user/conf.py
parent6b02fca71329ed858423b710699952b7f017034e (diff)
downloadqemu-091479301f96d0e1df0ab12f18d1b265979cba47.zip
qemu-091479301f96d0e1df0ab12f18d1b265979cba47.tar.gz
qemu-091479301f96d0e1df0ab12f18d1b265979cba47.tar.bz2
qemu-doc: convert user-mode emulation to a separate Sphinx manual
The final addition to the set of QEMU manuals is the user-mode emulation manual, which right now is included in qemu-doc.texi. Extract it and convert it to rST, so that qemu-doc.texi covers only full system emulation. Signed-off-by: Paolo Bonzini <pbonzini@redhat.com> Reviewed-by: Peter Maydell <peter.maydell@linaro.org> Reviewed-by: Alex Bennée <alex.bennee@linaro.org> Tested-by: Alex Bennée <alex.bennee@linaro.org> Signed-off-by: Peter Maydell <peter.maydell@linaro.org> Message-id: 20200228153619.9906-2-peter.maydell@linaro.org Message-id: 20200226113034.6741-2-pbonzini@redhat.com [PMM: Fix makefile conflicts; add user manual to index.rst and index.html.in; don't specify empty man_pages list; fixed a few comments to say 'user' rather than 'system'] Reviewed-by: Peter Maydell <peter.maydell@linaro.org> Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
Diffstat (limited to 'docs/user/conf.py')
-rw-r--r--docs/user/conf.py15
1 files changed, 15 insertions, 0 deletions
diff --git a/docs/user/conf.py b/docs/user/conf.py
new file mode 100644
index 0000000..4b09aed
--- /dev/null
+++ b/docs/user/conf.py
@@ -0,0 +1,15 @@
+# -*- coding: utf-8 -*-
+#
+# QEMU documentation build configuration file for the 'user' 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'User Mode Emulation User''s Guide'