From: Thomas Huth <thuth@redhat.com>
To: Stefan Hajnoczi <stefanha@redhat.com>, qemu-devel@nongnu.org
Cc: Peter Maydell <peter.maydell@linaro.org>,
Daniel Berrange <berrange@redhat.com>
Subject: Re: [PATCH v2] docs: build an index page for the HTML docs
Date: Tue, 17 Dec 2019 17:47:26 +0100 [thread overview]
Message-ID: <22747677-3ea5-b0f3-aaa8-20d501364d7d@redhat.com> (raw)
In-Reply-To: <20191111102157.440664-1-stefanha@redhat.com>
On 11/11/2019 11.21, Stefan Hajnoczi wrote:
> 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 <stefanha@redhat.com>
> ---
> 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 aa9d1a42aa..581bc68918 100644
> --- a/Makefile
> +++ b/Makefile
> @@ -347,6 +347,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
> @@ -818,6 +819,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)"
> @@ -1024,6 +1026,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..c2df85a185
> --- /dev/null
> +++ b/docs/index.html.in
> @@ -0,0 +1,17 @@
> +<!DOCTYPE html>
> +<html>
https://validator.w3.org/ says:
"Warning: Consider adding a lang attribute to the html start tag to
declare the language of this document."
... it's just a warning though, but in case you respin, you might want
to add it.
> + <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>
>
Reviewed-by: Thomas Huth <thuth@redhat.com>
prev parent reply other threads:[~2019-12-17 16:53 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-11-11 10:21 [PATCH v2] docs: build an index page for the HTML docs Stefan Hajnoczi
2019-12-17 16:36 ` Stefan Hajnoczi
2019-12-17 16:47 ` Thomas Huth [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=22747677-3ea5-b0f3-aaa8-20d501364d7d@redhat.com \
--to=thuth@redhat.com \
--cc=berrange@redhat.com \
--cc=peter.maydell@linaro.org \
--cc=qemu-devel@nongnu.org \
--cc=stefanha@redhat.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).