qemu/docs/index.html.in

<!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="system/index.html">System Emulation User's Guide</a></li>
            <li><a href="user/index.html">User Mode Emulation User's Guide</a></li>
            <li><a href="tools/index.html">Tools Guide</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>
            <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>
        </ul>
    </body>
</html>
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 <stefanha@redhat.com> Message-Id: <20191219135620.1626608-1-stefanha@redhat.com> Signed-off-by: Thomas Huth <thuth@redhat.com> 2019-12-19 13:56:20 +00:00			`<!DOCTYPE html>`
			`<html lang="en">`
			`<head>`
			`<meta charset="UTF-8">`
			`<title>QEMU @@VERSION@@ Documentation</title>`
			`</head>`
			`<body>`
			`<h1>QEMU @@VERSION@@ Documentation</h1>`
			`<ul>`
docs: Create stub system manual We want a user-facing manual which contains system emulation documentation. Create an empty one which we can populate. Signed-off-by: Peter Maydell <peter.maydell@linaro.org> Reviewed-by: Alex Bennée <alex.bennee@linaro.org> Acked-by: Stefan Hajnoczi <stefanha@redhat.com> Message-id: 20200116141511.16849-3-peter.maydell@linaro.org 2020-01-23 15:22:40 +00:00			`<li><a href="system/index.html">System Emulation User's Guide</a></li>`
qemu-doc: convert user-mode emulation to a separate Sphinx manual The final addition to the set of QEMU manuals is the user-mode emulation manual, which right now is included in qemu-doc.texi. Extract it and convert it to rST, so that qemu-doc.texi covers only full system emulation. Signed-off-by: Paolo Bonzini <pbonzini@redhat.com> Reviewed-by: Peter Maydell <peter.maydell@linaro.org> Reviewed-by: Alex Bennée <alex.bennee@linaro.org> Tested-by: Alex Bennée <alex.bennee@linaro.org> Signed-off-by: Peter Maydell <peter.maydell@linaro.org> Message-id: 20200228153619.9906-2-peter.maydell@linaro.org Message-id: 20200226113034.6741-2-pbonzini@redhat.com [PMM: Fix makefile conflicts; add user manual to index.rst and index.html.in; don't specify empty man_pages list; fixed a few comments to say 'user' rather than 'system'] Reviewed-by: Peter Maydell <peter.maydell@linaro.org> Signed-off-by: Peter Maydell <peter.maydell@linaro.org> 2020-02-28 15:35:47 +00:00			`<li><a href="user/index.html">User Mode Emulation User's Guide</a></li>`
docs/index.rst, docs/index.html.in: Reorder manuals Now that qemu-doc.html is no longer present, the ordering of manuals within the top-level index page looks a bit odd. Reshuffle so that the manuals the user is most likely to be interested in are at the top of the list, and the reference material is at the bottom. Similarly, we reorder the index.rst file used as the base of the "all manuals in one" documentation for readthedocs. The new order is: * system * user * tools * interop * specs * QMP reference (if present) * Guest agent protocol reference (if present) * devel (if present) Signed-off-by: Peter Maydell <peter.maydell@linaro.org> Reviewed-by: Richard Henderson <richard.henderson@linaro.org> Message-id: 20200306171749.10756-7-peter.maydell@linaro.org 2020-03-06 17:17:48 +00:00			`<li><a href="tools/index.html">Tools Guide</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>`
			`<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>`
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 <stefanha@redhat.com> Message-Id: <20191219135620.1626608-1-stefanha@redhat.com> Signed-off-by: Thomas Huth <thuth@redhat.com> 2019-12-19 13:56:20 +00:00			`</ul>`
			`</body>`
			`</html>`