[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PULL 8/8] docs: build an index page for the HTML docs
From: |
Thomas Huth |
Subject: |
[PULL 8/8] docs: build an index page for the HTML docs |
Date: |
Tue, 7 Jan 2020 20:08:02 +0100 |
From: Stefan Hajnoczi <address@hidden>
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 <address@hidden>
Message-Id: <address@hidden>
Signed-off-by: Thomas Huth <address@hidden>
---
Makefile | 6 ++++++
docs/index.html.in | 17 +++++++++++++++++
2 files changed, 23 insertions(+)
create mode 100644 docs/index.html.in
diff --git a/Makefile b/Makefile
index 6b5ad1121b..32bd554480 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 0000000000..94eb782cf7
--- /dev/null
+++ b/docs/index.html.in
@@ -0,0 +1,17 @@
+<!DOCTYPE html>
+<html lang="en">
+ <head>
+ <meta charset="UTF-8">
+ <title>QEMU @@VERSION@@ Documentation</title>
+ </head>
+ <body>
+ <h1>QEMU @@VERSION@@ Documentation</h1>
+ <ul>
+ <li><a href="qemu-doc.html">User Documentation</a></li>
+ <li><a href="qemu-qmp-ref.html">QMP Reference Manual</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="specs/index.html">System Emulation Guest Hardware
Specifications</a></li>
+ </ul>
+ </body>
+</html>
--
2.18.1
- [PULL 0/8] qtests and docs, Thomas Huth, 2020/01/07
- [PULL 1/8] tests/Makefile: test-char does not need libqtest, Thomas Huth, 2020/01/07
- [PULL 2/8] tests/ptimer: Remove unnecessary inclusion of libqtest.h, Thomas Huth, 2020/01/07
- [PULL 3/8] tests/Makefile: Remove 'tests/' and '$(EXESUF)' from the check-qtest variables, Thomas Huth, 2020/01/07
- [PULL 4/8] tests/Makefile: Separate unit test dependencies from qtest dependencies, Thomas Huth, 2020/01/07
- [PULL 6/8] tests/Makefile: Move qtest-related settings to a separate Makefile.include, Thomas Huth, 2020/01/07
- [PULL 8/8] docs: build an index page for the HTML docs,
Thomas Huth <=
- [PULL 7/8] tests/libqos: Move the libqos files under tests/qtest/, Thomas Huth, 2020/01/07
- [PULL 5/8] test: Move qtests to a separate directory, Thomas Huth, 2020/01/07
- Re: [PULL 0/8] qtests and docs, Peter Maydell, 2020/01/10