aboutsummaryrefslogtreecommitdiff
path: root/docs/_templates
diff options
context:
space:
mode:
authorPeter Maydell <peter.maydell@linaro.org>2021-07-05 10:55:46 +0100
committerPeter Maydell <peter.maydell@linaro.org>2021-07-18 10:59:47 +0100
commit13f934e79fa72d28a2c7de584a45c646b65d524f (patch)
tree5e51ec5af072f7d12f869801a16bcd1669d879c2 /docs/_templates
parent4a43fa3af926bb2ceef8f7ed188a41c70e0e8477 (diff)
downloadqemu-13f934e79fa72d28a2c7de584a45c646b65d524f.zip
qemu-13f934e79fa72d28a2c7de584a45c646b65d524f.tar.gz
qemu-13f934e79fa72d28a2c7de584a45c646b65d524f.tar.bz2
docs: Add license note to the HTML page footer
The standard Sphinx/RTD HTML page footer gives a copyright line (based on the 'copyright' variable set in conf.py) and a line "Built with Sphinx using a theme provided by Read the Docs" (which can be disabled via the html_show_sphinx variable, but we leave it enabled). As a free software project, we'd like to also mention the license QEMU and its manual are released under. Add a template footer.html which defines the 'extrafooter' block that the RtD theme provides for this purpose. The new line of text will go below the existing copyright and sphinx-acknowledgement lines. (Unfortunately the RTD footer template does not permit putting it after the copyright but before the sphinx-acknowledgement.) We use the templating functionality to make the new text also be a hyperlink to the about/license.html page of the manual. Unlike rst files, HTML template files are not reported to our depfile plugin, so we maintain a manual list in meson.build. New template files should be rare, so not being able to auto-generate the dependency info is not too awkward. Signed-off-by: Peter Maydell <peter.maydell@linaro.org> Acked-by: Markus Armbruster <armbru@redhat.com> Reviewed-by: Daniel P. Berrangé <berrange@redhat.com> Message-id: 20210705095547.15790-7-peter.maydell@linaro.org
Diffstat (limited to 'docs/_templates')
-rw-r--r--docs/_templates/footer.html12
1 files changed, 12 insertions, 0 deletions
diff --git a/docs/_templates/footer.html b/docs/_templates/footer.html
new file mode 100644
index 0000000..4c15e17
--- /dev/null
+++ b/docs/_templates/footer.html
@@ -0,0 +1,12 @@
+{% extends "!footer.html" %}
+{% block extrafooter %}
+
+<!-- Empty para to force a blank line after "Built with Sphinx ..." -->
+<p></p>
+
+{% trans path=pathto('about/license') %}
+<p><a href="{{ path }}">QEMU and this manual are released under the
+GNU General Public License, version 2.</a></p>
+{% endtrans %}
+{{ super() }}
+{% endblock %}