aboutsummaryrefslogtreecommitdiff
path: root/docs/tools
diff options
context:
space:
mode:
authorPeter Maydell <peter.maydell@linaro.org>2020-02-25 10:45:13 +0000
committerPeter Maydell <peter.maydell@linaro.org>2020-02-25 10:48:04 +0000
commit65c3542b1f4e6ad5648a6ee0f7ebc8bcc39035d3 (patch)
tree91c18a38a2cccd61da5af8413bb6f44ca3f544a4 /docs/tools
parentc1e667d2598b9b3ce62b8e89ed22dd38dfe9f57f (diff)
docs: Create new 'tools' manual
Some of the documentation for QEMU "tools" which are standalone binaries like qemu-img is an awkward fit in our current 5-manual split. We've put it into "interop", but they're not really about interoperability. Create a new top level manual "tools" which will be a better home for this documentation. This commit creates an empty initial manual; we will move the relevant documentation files in a subsequent commit. Signed-off-by: Peter Maydell <peter.maydell@linaro.org> Reviewed-by: Richard Henderson <richard.henderson@linaro.org> Acked-by: Paolo Bonzini <pbonzini@redhat.com> Message-id: 20200217155415.30949-2-peter.maydell@linaro.org
Diffstat (limited to 'docs/tools')
-rw-r--r--docs/tools/conf.py16
-rw-r--r--docs/tools/index.rst11
2 files changed, 27 insertions, 0 deletions
diff --git a/docs/tools/conf.py b/docs/tools/conf.py
new file mode 100644
index 0000000000..56461110b9
--- /dev/null
+++ b/docs/tools/conf.py
@@ -0,0 +1,16 @@
+# -*- coding: utf-8 -*-
+#
+# QEMU documentation build configuration file for the 'tools' 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'Tools Guide'
diff --git a/docs/tools/index.rst b/docs/tools/index.rst
new file mode 100644
index 0000000000..c5a4a13ec7
--- /dev/null
+++ b/docs/tools/index.rst
@@ -0,0 +1,11 @@
+.. This is the top level page for the 'tools' manual
+
+
+QEMU Tools Guide
+================
+
+
+Contents:
+
+.. toctree::
+ :maxdepth: 2