From: Stefan Hajnoczi Date: Thu, 19 Dec 2019 13:56:20 +0000 (+0000) Subject: docs: build an index page for the HTML docs X-Git-Tag: v5.0.0-rc0~149^2 X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=22108f333d16cbfbd5808bb4f661c394b08fe698;p=thirdparty%2Fqemu.git docs: build an index page for the HTML docs There is no index.html start page for the QEMU HTML documentation. An index page is needed so that documentation can be browsed easily on the web. This patch adds an index.html.in template file where the QEMU version number is expanded. It is written in HTML instead of using the existing sphinx (rST) and texi documentation generators because they are heavyweight and would make this harder. Signed-off-by: Stefan Hajnoczi Message-Id: <20191219135620.1626608-1-stefanha@redhat.com> Signed-off-by: Thomas Huth --- diff --git a/Makefile b/Makefile index 6b5ad1121b2..32bd554480e 100644 --- a/Makefile +++ b/Makefile @@ -343,6 +343,7 @@ DOCS+=docs/interop/qemu-qmp-ref.html docs/interop/qemu-qmp-ref.txt docs/interop/ DOCS+=docs/interop/qemu-ga-ref.html docs/interop/qemu-ga-ref.txt docs/interop/qemu-ga-ref.7 DOCS+=docs/qemu-block-drivers.7 DOCS+=docs/qemu-cpu-models.7 +DOCS+=$(MANUAL_BUILDDIR)/index.html ifdef CONFIG_VIRTFS DOCS+=fsdev/virtfs-proxy-helper.1 endif @@ -811,6 +812,7 @@ install-sphinxdocs: sphinxdocs install-doc: $(DOCS) install-sphinxdocs $(INSTALL_DIR) "$(DESTDIR)$(qemu_docdir)" + $(INSTALL_DATA) $(MANUAL_BUILDDIR)/index.html "$(DESTDIR)$(qemu_docdir)" $(INSTALL_DATA) qemu-doc.html "$(DESTDIR)$(qemu_docdir)" $(INSTALL_DATA) qemu-doc.txt "$(DESTDIR)$(qemu_docdir)" $(INSTALL_DATA) docs/interop/qemu-qmp-ref.html "$(DESTDIR)$(qemu_docdir)" @@ -1017,6 +1019,10 @@ $(MANUAL_BUILDDIR)/specs/index.html: $(call manual-deps,specs) $(MANUAL_BUILDDIR)/interop/qemu-ga.8: $(call manual-deps,interop) $(call build-manual,interop,man) +$(MANUAL_BUILDDIR)/index.html: $(SRC_PATH)/docs/index.html.in qemu-version.h + $(call quiet-command, sed "s|@@VERSION@@|${VERSION}|g" $< >$@, \ + "GEN","$@") + qemu-options.texi: $(SRC_PATH)/qemu-options.hx $(SRC_PATH)/scripts/hxtool $(call quiet-command,sh $(SRC_PATH)/scripts/hxtool -t < $< > $@,"GEN","$@") diff --git a/docs/index.html.in b/docs/index.html.in new file mode 100644 index 00000000000..94eb782cf7e --- /dev/null +++ b/docs/index.html.in @@ -0,0 +1,17 @@ + + + + + QEMU @@VERSION@@ Documentation + + +

QEMU @@VERSION@@ Documentation

+ +