aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--Makefile8
-rw-r--r--docs/index.html.in1
-rw-r--r--docs/index.rst1
-rw-r--r--docs/tools/conf.py16
-rw-r--r--docs/tools/index.rst11
5 files changed, 36 insertions, 1 deletions
diff --git a/Makefile b/Makefile
index 15f8e53..c4c2eba 100644
--- a/Makefile
+++ b/Makefile
@@ -786,6 +786,7 @@ distclean: clean
$(call clean-manual,interop)
$(call clean-manual,specs)
$(call clean-manual,system)
+ $(call clean-manual,tools)
for d in $(TARGET_DIRS); do \
rm -rf $$d || exit 1 ; \
done
@@ -843,6 +844,7 @@ install-sphinxdocs: sphinxdocs
$(call install-manual,interop)
$(call install-manual,specs)
$(call install-manual,system)
+ $(call install-manual,tools)
install-doc: $(DOCS) install-sphinxdocs
$(INSTALL_DIR) "$(DESTDIR)$(qemu_docdir)"
@@ -1036,7 +1038,8 @@ docs/version.texi: $(SRC_PATH)/VERSION config-host.mak
sphinxdocs: $(MANUAL_BUILDDIR)/devel/index.html \
$(MANUAL_BUILDDIR)/interop/index.html \
$(MANUAL_BUILDDIR)/specs/index.html \
- $(MANUAL_BUILDDIR)/system/index.html
+ $(MANUAL_BUILDDIR)/system/index.html \
+ $(MANUAL_BUILDDIR)/tools/index.html
# Canned command to build a single manual
# Arguments: $1 = manual name, $2 = Sphinx builder ('html' or 'man')
@@ -1069,6 +1072,9 @@ $(MANUAL_BUILDDIR)/specs/index.html: $(call manual-deps,specs)
$(MANUAL_BUILDDIR)/system/index.html: $(call manual-deps,system)
$(call build-manual,system,html)
+$(MANUAL_BUILDDIR)/tools/index.html: $(call manual-deps,tools)
+ $(call build-manual,tools,html)
+
$(call define-manpage-rule,interop,\
qemu-ga.8 qemu-img.1 qemu-nbd.8 qemu-trace-stap.1\
virtiofsd.1 virtfs-proxy-helper.1,\
diff --git a/docs/index.html.in b/docs/index.html.in
index 8512933..cf61b1c 100644
--- a/docs/index.html.in
+++ b/docs/index.html.in
@@ -13,6 +13,7 @@
<li><a href="interop/index.html">System Emulation Management and Interoperability Guide</a></li>
<li><a href="specs/index.html">System Emulation Guest Hardware Specifications</a></li>
<li><a href="system/index.html">System Emulation User's Guide</a></li>
+ <li><a href="tools/index.html">Tools Guide</a></li>
</ul>
</body>
</html>
diff --git a/docs/index.rst b/docs/index.rst
index 46405d4..acd604f 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -14,3 +14,4 @@ Welcome to QEMU's documentation!
devel/index
specs/index
system/index
+ tools/index
diff --git a/docs/tools/conf.py b/docs/tools/conf.py
new file mode 100644
index 0000000..5646111
--- /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 0000000..c5a4a13
--- /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