Re: [PATCH 6/7] docs: Add license note to the HTML page footer

[Daniel P . Berrangé]

On Mon, Jul 05, 2021 at 10:55:46AM +0100, Peter Maydell wrote:
> 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>
> ---
> I know nothing about Jinja, and have merely cargo-culted the
> "make a link to a document" stuff from the handling of the
> optional copyright link in /usr/share/sphinx_rtd_theme/footer.html ...
> ---
>  docs/_templates/footer.html | 12 ++++++++++++
>  docs/meson.build            |  3 ++-
>  MAINTAINERS                 |  1 +
>  3 files changed, 15 insertions(+), 1 deletion(-)
>  create mode 100644 docs/_templates/footer.html

Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>


Regards,
Daniel
-- 
|: https://berrange.com      -o-    https://www.flickr.com/photos/dberrange :|
|: https://libvirt.org         -o-            https://fstop138.berrange.com :|
|: https://entangle-photo.org    -o-    https://www.instagram.com/dberrange :|