From 2c7feb021b045afb05b38c4268683a9f40399bfd Mon Sep 17 00:00:00 2001
From: Peter Chang <peter.chang@diamond.ac.uk>
Date: Fri, 16 Jun 2023 09:19:09 +0100
Subject: [PATCH] Add workflow step to CI to publish HTML version of the
 Impatient Guide (fixes #1257)

Also update copyright year for guide and tweak .gitignore
---
 .github/workflows/ci.yaml | 13 ++++++++++---
 .gitignore                |  1 +
 impatient-guide/conf.py   |  7 ++++---
 3 files changed, 15 insertions(+), 6 deletions(-)

diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
index 4bed1ad8eb..2887bd0ea3 100644
--- a/.github/workflows/ci.yaml
+++ b/.github/workflows/ci.yaml
@@ -72,7 +72,7 @@ jobs:
         run: |
           make prepare
 
-      - name: Build Impatient Guid
+      - name: Build Impatient Guide
         run: |
           make impatient-guide
           ls -lAFgh build/impatient-guide/build/html/index.html
@@ -87,12 +87,19 @@ jobs:
 
       - name: Build and Commit the User Manual
         if: ${{ github.event.inputs.deploy && env.python_version == env.python_deploy_version }}
-        uses: sphinx-notes/pages@master
+        uses: sphinx-notes/pages@v3
         with:
           # path to the conf.py directory
           documentation_path: build/manual/source
 
-      - name: Deploy the User Manual
+      - name: Build and Commit the Impatient Guide
+        if: ${{ github.event.inputs.deploy && env.python_version == env.python_deploy_version }}
+        uses: sphinx-notes/pages@v3
+        with:
+          # path to the conf.py directory
+          documentation_path: build/impatient-guide
+
+      - name: Deploy both the User Manual and the Impatient Guide
         if: ${{ github.event.inputs.deploy && env.python_version == env.python_deploy_version }}
         uses: ad-m/github-push-action@master
         with:
diff --git a/.gitignore b/.gitignore
index ff21c1627c..ae7946a348 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,5 +1,6 @@
 # Hidden files
 .*
+!.github
 
 # Python byte / compiled / optimized
 *.py[cod]
diff --git a/impatient-guide/conf.py b/impatient-guide/conf.py
index 165ad7d7aa..b72068fe22 100644
--- a/impatient-guide/conf.py
+++ b/impatient-guide/conf.py
@@ -40,17 +40,18 @@
 master_doc = 'index'
 
 # General information about the project.
+year = '2022' # str(datetime.datetime.now().year)
 project = u'NeXus for the Impatient'
-copyright = u'2014-2016, http://nexusformat.org'
+copyright = u'2014-{}, http://nexusformat.org'.format(year)
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 # The short X.Y version.
-version = '2016'
+version = year
 # The full version, including alpha/beta/rc tags.
-release = '2016'
+release = year
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.