Commit 0783a732 authored by Peter Maydell's avatar Peter Maydell
Browse files

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: default avatarPeter Maydell <peter.maydell@linaro.org>
Acked-by: default avatarAleksandar Markovic <amarkovic@wavecomp.com>
Message-id: 20190610152444.20859-3-peter.maydell@linaro.org
parent 9b4cc0c2

Makefile

+6 −1
Original line number Diff line number Diff line
@@ -731,6 +731,7 @@ distclean: clean 
	rm -rf .doctrees

	$(call clean-manual,devel)

	$(call clean-manual,interop)

	$(call clean-manual,specs)

	for d in $(TARGET_DIRS); do \

	rm -rf $$d || exit 1 ; \

        done
@@ -781,6 +782,7 @@ endef 
.PHONY: install-sphinxdocs

install-sphinxdocs: sphinxdocs

	$(call install-manual,interop)

	$(call install-manual,specs)



install-doc: $(DOCS) install-sphinxdocs

	$(INSTALL_DIR) "$(DESTDIR)$(qemu_docdir)"
@@ -962,7 +964,7 @@ docs/version.texi: $(SRC_PATH)/VERSION config-host.mak 
# and handles "don't rebuild things unless necessary" itself.

# The '.doctrees' files are cached information to speed this up.

.PHONY: sphinxdocs

sphinxdocs: $(MANUAL_BUILDDIR)/devel/index.html $(MANUAL_BUILDDIR)/interop/index.html

sphinxdocs: $(MANUAL_BUILDDIR)/devel/index.html $(MANUAL_BUILDDIR)/interop/index.html $(MANUAL_BUILDDIR)/specs/index.html



# Canned command to build a single manual

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")
@@ -975,6 +977,9 @@ $(MANUAL_BUILDDIR)/devel/index.html: $(call manual-deps,devel) 
$(MANUAL_BUILDDIR)/interop/index.html: $(call manual-deps,interop)

	$(call build-manual,interop)



$(MANUAL_BUILDDIR)/specs/index.html: $(call manual-deps,specs)

	$(call build-manual,specs)



qemu-options.texi: $(SRC_PATH)/qemu-options.hx $(SRC_PATH)/scripts/hxtool

	$(call quiet-command,sh $(SRC_PATH)/scripts/hxtool -t < $< > $@,"GEN","$@")

docs/specs/conf.py

0 → 100644
+16 −0
Original line number Diff line number Diff line 
# -*- coding: utf-8 -*-

#

# QEMU documentation build configuration file for the 'specs' 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 Guest Hardware Specifications'