From c51dab213b92b9e7eb1a95e5f650c9fec0f5b9d4 Mon Sep 17 00:00:00 2001
From: tkknight <2108488+tkknight@users.noreply.github.com>
Date: Tue, 9 Feb 2021 12:14:40 +0000
Subject: [PATCH] Added text to state the Python version used to build the
 docs. (#3989)

* Added text to state the Python version used to build the docs.

* Added footer template that includes the Python version used to build.

* added new line

* Review actions

* added whatsnew
---
 docs/src/_templates/footer.html                    |  5 +++++
 docs/src/conf.py                                   | 14 +++++++++-----
 .../contributing_documentation.rst                 |  3 +++
 docs/src/installing.rst                            |  4 +++-
 docs/src/whatsnew/latest.rst                       |  4 ++++
 5 files changed, 24 insertions(+), 6 deletions(-)
 create mode 100644 docs/src/_templates/footer.html

diff --git a/docs/src/_templates/footer.html b/docs/src/_templates/footer.html
new file mode 100644
index 0000000000..1d5fb08b78
--- /dev/null
+++ b/docs/src/_templates/footer.html
@@ -0,0 +1,5 @@
+{% extends "!footer.html" %}
+{% block extrafooter %}
+   Built using Python {{ python_version }}.
+   {{ super() }}
+{% endblock %}
diff --git a/docs/src/conf.py b/docs/src/conf.py
index 30e6150b39..843af17944 100644
--- a/docs/src/conf.py
+++ b/docs/src/conf.py
@@ -69,8 +69,8 @@ def autolog(message):
 
 # define the copyright information for latex builds. Note, for html builds,
 # the copyright exists directly inside "_templates/layout.html"
-upper_copy_year = datetime.datetime.now().year
-copyright = "Iris Contributors"
+copyright_years = f"2010 - {datetime.datetime.now().year}"
+copyright = f"{copyright_years}, Iris Contributors"
 author = "Iris Developers"
 
 # The version info for the project you're documenting, acts as replacement for
@@ -95,9 +95,12 @@ def autolog(message):
 
 # Create a variable that can be inserted in the rst "|copyright_years|".
 # You can add more variables here if needed.
+
+build_python_version = ".".join([str(i) for i in sys.version_info[:3]])
+
 rst_epilog = f"""
-.. |copyright_years| replace:: 2010 - {upper_copy_year}
-.. |python_version| replace:: {'.'.join([str(i) for i in sys.version_info[:3]])}
+.. |copyright_years| replace:: {copyright_years}
+.. |python_version| replace:: {build_python_version}
 .. |iris_version| replace:: v{version}
 .. |build_date| replace:: ({datetime.datetime.now().strftime('%d %b %Y')})
 """
@@ -225,7 +228,8 @@ def autolog(message):
 }
 
 html_context = {
-    "copyright_years": "2010 - {}".format(upper_copy_year),
+    "copyright_years": copyright_years,
+    "python_version": build_python_version,
     # menu_links and menu_links_name are used in _templates/layout.html
     # to include some nice icons.  See http://fontawesome.io for a list of
     # icons (used in the sphinx_rtd_theme)
diff --git a/docs/src/developers_guide/contributing_documentation.rst b/docs/src/developers_guide/contributing_documentation.rst
index 75e9dfe29c..167e8937b9 100644
--- a/docs/src/developers_guide/contributing_documentation.rst
+++ b/docs/src/developers_guide/contributing_documentation.rst
@@ -24,6 +24,9 @@ The documentation uses specific packages that need to be present.  Please see
 Building
 ~~~~~~~~
 
+This documentation was built using the latest Python version that Iris
+supports.  For more information see :ref:`installing_iris`.
+
 The build can be run from the documentation directory ``docs/src``.
 
 The build output for the html is found in the ``_build/html`` sub directory.
diff --git a/docs/src/installing.rst b/docs/src/installing.rst
index 8b3ae8d3e7..31fc497b85 100644
--- a/docs/src/installing.rst
+++ b/docs/src/installing.rst
@@ -17,7 +17,9 @@ any WSL_ distributions.
 .. _WSL: https://docs.microsoft.com/en-us/windows/wsl/install-win10
 
 .. note:: Iris currently supports and is tested against **Python 3.6** and
-          **Python 3.7**.
+          **Python 3.7**.  
+          
+.. note:: This documentation was built using Python |python_version|.
 
 
 .. _installing_using_conda:
diff --git a/docs/src/whatsnew/latest.rst b/docs/src/whatsnew/latest.rst
index ed11f60719..1efa08874a 100644
--- a/docs/src/whatsnew/latest.rst
+++ b/docs/src/whatsnew/latest.rst
@@ -83,6 +83,10 @@ This document explains the changes made to Iris for this release
 #. `@bjlittle`_ added automated Iris version discovery for the ``latest.rst``
    in the ``whatsnew`` documentation. (:pull:`3981`)
 
+#. `@tkknight`_ stated the Python version used to build the documentation
+   on :ref:`installing_iris` and to the footer of all pages.  Also added the
+   copyright years to the footer. (:pull:`3989`)
+
 
 💼 Internal
 ===========