diff mbox series

[1/3] docs: Create new 'tools' manual

Message ID 20200217155415.30949-2-peter.maydell@linaro.org (mailing list archive)
State New, archived
Headers show
Series docs: Create a 'tools' manual | expand

Commit Message

Peter Maydell Feb. 17, 2020, 3:54 p.m. UTC 
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>
---
 Makefile             |  8 +++++++-
 docs/index.html.in   |  1 +
 docs/index.rst       |  1 +
 docs/tools/conf.py   | 16 ++++++++++++++++
 docs/tools/index.rst | 11 +++++++++++
 5 files changed, 36 insertions(+), 1 deletion(-)
 create mode 100644 docs/tools/conf.py
 create mode 100644 docs/tools/index.rst
diff mbox series

Patch

diff --git a/Makefile b/Makefile
index b5a7377cb18..ceb85f67c4b 100644
--- a/Makefile
+++ b/Makefile
@@ -773,6 +773,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
@@ -830,6 +831,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)"
@@ -1023,7 +1025,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')
@@ -1056,6 +1059,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 8512933d145..cf61b1cf448 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 46405d4f077..acd604fa8a9 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 00000000000..56461110b9d
--- /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 00000000000..c5a4a13ec7a
--- /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