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 <peter.maydell@linaro.org> Reviewed-by: Alex Bennée <alex.bennee@linaro.org> Acked-by: Stefan Hajnoczi <stefanha@redhat.com> Message-id: 20200116141511.16849-3-peter.maydell@linaro.org
This commit is contained in:
parent
87c0868f46
commit
0928523a12
10
Makefile
10
Makefile
|
@ -757,6 +757,7 @@ distclean: clean
|
||||||
$(call clean-manual,devel)
|
$(call clean-manual,devel)
|
||||||
$(call clean-manual,interop)
|
$(call clean-manual,interop)
|
||||||
$(call clean-manual,specs)
|
$(call clean-manual,specs)
|
||||||
|
$(call clean-manual,system)
|
||||||
for d in $(TARGET_DIRS); do \
|
for d in $(TARGET_DIRS); do \
|
||||||
rm -rf $$d || exit 1 ; \
|
rm -rf $$d || exit 1 ; \
|
||||||
done
|
done
|
||||||
|
@ -813,6 +814,7 @@ endef
|
||||||
install-sphinxdocs: sphinxdocs
|
install-sphinxdocs: sphinxdocs
|
||||||
$(call install-manual,interop)
|
$(call install-manual,interop)
|
||||||
$(call install-manual,specs)
|
$(call install-manual,specs)
|
||||||
|
$(call install-manual,system)
|
||||||
|
|
||||||
install-doc: $(DOCS) install-sphinxdocs
|
install-doc: $(DOCS) install-sphinxdocs
|
||||||
$(INSTALL_DIR) "$(DESTDIR)$(qemu_docdir)"
|
$(INSTALL_DIR) "$(DESTDIR)$(qemu_docdir)"
|
||||||
|
@ -1000,7 +1002,10 @@ docs/version.texi: $(SRC_PATH)/VERSION config-host.mak
|
||||||
# and handles "don't rebuild things unless necessary" itself.
|
# and handles "don't rebuild things unless necessary" itself.
|
||||||
# The '.doctrees' files are cached information to speed this up.
|
# The '.doctrees' files are cached information to speed this up.
|
||||||
.PHONY: sphinxdocs
|
.PHONY: sphinxdocs
|
||||||
sphinxdocs: $(MANUAL_BUILDDIR)/devel/index.html $(MANUAL_BUILDDIR)/interop/index.html $(MANUAL_BUILDDIR)/specs/index.html
|
sphinxdocs: $(MANUAL_BUILDDIR)/devel/index.html \
|
||||||
|
$(MANUAL_BUILDDIR)/interop/index.html \
|
||||||
|
$(MANUAL_BUILDDIR)/specs/index.html \
|
||||||
|
$(MANUAL_BUILDDIR)/system/index.html
|
||||||
|
|
||||||
# Canned command to build a single manual
|
# Canned command to build a single manual
|
||||||
# Arguments: $1 = manual name, $2 = Sphinx builder ('html' or 'man')
|
# Arguments: $1 = manual name, $2 = Sphinx builder ('html' or 'man')
|
||||||
|
@ -1022,6 +1027,9 @@ $(MANUAL_BUILDDIR)/interop/index.html: $(call manual-deps,interop)
|
||||||
$(MANUAL_BUILDDIR)/specs/index.html: $(call manual-deps,specs)
|
$(MANUAL_BUILDDIR)/specs/index.html: $(call manual-deps,specs)
|
||||||
$(call build-manual,specs,html)
|
$(call build-manual,specs,html)
|
||||||
|
|
||||||
|
$(MANUAL_BUILDDIR)/system/index.html: $(call manual-deps,system)
|
||||||
|
$(call build-manual,system,html)
|
||||||
|
|
||||||
$(MANUAL_BUILDDIR)/interop/qemu-ga.8: $(call manual-deps,interop)
|
$(MANUAL_BUILDDIR)/interop/qemu-ga.8: $(call manual-deps,interop)
|
||||||
$(call build-manual,interop,man)
|
$(call build-manual,interop,man)
|
||||||
|
|
||||||
|
|
|
@ -12,6 +12,7 @@
|
||||||
<li><a href="qemu-ga-ref.html">Guest Agent Protocol Reference</a></li>
|
<li><a href="qemu-ga-ref.html">Guest Agent Protocol Reference</a></li>
|
||||||
<li><a href="interop/index.html">System Emulation Management and Interoperability Guide</a></li>
|
<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="specs/index.html">System Emulation Guest Hardware Specifications</a></li>
|
||||||
|
<li><a href="system/index.html">System Emulation User's Guide</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</body>
|
</body>
|
||||||
</html>
|
</html>
|
||||||
|
|
|
@ -13,4 +13,4 @@ Welcome to QEMU's documentation!
|
||||||
interop/index
|
interop/index
|
||||||
devel/index
|
devel/index
|
||||||
specs/index
|
specs/index
|
||||||
|
system/index
|
||||||
|
|
|
@ -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'
|
|
@ -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
|
||||||
|
|
Loading…
Reference in New Issue