From 17490255ced352e4373ede653da78a21cadd4c25 Mon Sep 17 00:00:00 2001
From: Tom Cobb <tom.cobb@diamond.ac.uk>
Date: Wed, 23 Jun 2021 20:15:19 +0100
Subject: [PATCH] Docs tweaks

---
 .github/workflows/docs.yml      | 3 +--
 CONTRIBUTING.rst                | 2 ++
 docs/tutorials/installation.rst | 4 ++++
 tests/sim_records.py            | 0
 4 files changed, 7 insertions(+), 2 deletions(-)
 mode change 100755 => 100644 tests/sim_records.py

diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
index 57411f27..ae4878a6 100644
--- a/.github/workflows/docs.yml
+++ b/.github/workflows/docs.yml
@@ -36,7 +36,6 @@ jobs:
         with:
           msg: ${{ github.ref }}
           seperator: /
-          maxsplit: 2
 
       - name: Move to versioned directory
         # e.g. master or 0.1.2
@@ -44,7 +43,7 @@ jobs:
 
       - name: Publish Docs to gh-pages
         # Only master and tags are published
-        if: "${{ github.repository_owner == 'dls-controls' }}"
+        if: "${{ github.repository_owner == 'dls-controls' && (github.ref == 'refs/heads/master' || startsWith(github.ref, 'refs/tags')) }}"
         # We pin to the SHA, not the tag, for security reasons.
         # https://docs.github.com/en/free-pro-team@latest/actions/learn-github-actions/security-hardening-for-github-actions#using-third-party-actions
         uses: peaceiris/actions-gh-pages@bbdfb200618d235585ad98e965f4aafc39b4c501  # v3.7.3
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
index 67b5db65..a32d921f 100644
--- a/CONTRIBUTING.rst
+++ b/CONTRIBUTING.rst
@@ -17,6 +17,8 @@ To get the source source code and run the unit tests, run::
 
     $ git clone git://github.com/dls-controls/pythonIoc.git
     $ cd pythonIoc
+    $ git submodule init
+    $ git submodule update
     $ pipenv install --dev
     $ pipenv run tests
 
diff --git a/docs/tutorials/installation.rst b/docs/tutorials/installation.rst
index b8d6ade2..9cde2b00 100644
--- a/docs/tutorials/installation.rst
+++ b/docs/tutorials/installation.rst
@@ -35,6 +35,10 @@ You can now use ``pip`` to install the library::
 
     python3 -m pip install softioc
 
+Optionally you can install cothread, which is used in the first tutorial::
+
+    python3 -m pip install cothread
+
 If you require a feature that is not currently released you can also install
 from github::
 
diff --git a/tests/sim_records.py b/tests/sim_records.py
old mode 100755
new mode 100644