jcs.org
qemu with hax to log dma reads & writes
jcs.org/2018/11/12/vfio
docs: Build and install specs manual
Now we have some rST format docs in the docs/specs/ manual, we should
actually build and install it.
Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
Acked-by: Aleksandar Markovic <amarkovic@wavecomp.com>
Message-id: 20190610152444.20859-3-peter.maydell@linaro.org
+22
-1
+6
-1
Makefile
+6
-1
Makefile
···
731
731
rm -rf .doctrees
732
732
$(call clean-manual,devel)
733
733
$(call clean-manual,interop)
734
+
$(call clean-manual,specs)
734
735
for d in $(TARGET_DIRS); do \
735
736
rm -rf $$d || exit 1 ; \
736
737
done
···
781
782
.PHONY: install-sphinxdocs
782
783
install-sphinxdocs: sphinxdocs
783
784
$(call install-manual,interop)
785
+
$(call install-manual,specs)
784
786
785
787
install-doc: $(DOCS) install-sphinxdocs
786
788
$(INSTALL_DIR) "$(DESTDIR)$(qemu_docdir)"
···
962
964
# and handles "don't rebuild things unless necessary" itself.
963
965
# The '.doctrees' files are cached information to speed this up.
964
966
.PHONY: sphinxdocs
965
-
sphinxdocs: $(MANUAL_BUILDDIR)/devel/index.html $(MANUAL_BUILDDIR)/interop/index.html
967
+
sphinxdocs: $(MANUAL_BUILDDIR)/devel/index.html $(MANUAL_BUILDDIR)/interop/index.html $(MANUAL_BUILDDIR)/specs/index.html
966
968
967
969
# Canned command to build a single manual
968
970
build-manual = $(call quiet-command,sphinx-build $(if $(V),,-q) -W -n -b html -D version=$(VERSION) -D release="$(FULL_VERSION)" -d .doctrees/$1 $(SRC_PATH)/docs/$1 $(MANUAL_BUILDDIR)/$1 ,"SPHINX","$(MANUAL_BUILDDIR)/$1")
···
974
976
975
977
$(MANUAL_BUILDDIR)/interop/index.html: $(call manual-deps,interop)
976
978
$(call build-manual,interop)
979
+
980
+
$(MANUAL_BUILDDIR)/specs/index.html: $(call manual-deps,specs)
981
+
$(call build-manual,specs)
977
982
978
983
qemu-options.texi: $(SRC_PATH)/qemu-options.hx $(SRC_PATH)/scripts/hxtool
979
984
$(call quiet-command,sh $(SRC_PATH)/scripts/hxtool -t < $< > $@,"GEN","$@")
+16
docs/specs/conf.py
+16
docs/specs/conf.py
···
1
+
# -*- coding: utf-8 -*-
2
+
#
3
+
# QEMU documentation build configuration file for the 'specs' manual.
4
+
#
5
+
# This includes the top level conf file and then makes any necessary tweaks.
6
+
import sys
7
+
import os
8
+
9
+
qemu_docdir = os.path.abspath("..")
10
+
parent_config = os.path.join(qemu_docdir, "conf.py")
11
+
exec(compile(open(parent_config, "rb").read(), parent_config, 'exec'))
12
+
13
+
# This slightly misuses the 'description', but is the best way to get
14
+
# the manual title to appear in the sidebar.
15
+
html_theme_options['description'] = \
16
+
u'System Emulation Guest Hardware Specifications'