Merge pull request #10 from dls-controls/docs-test

Docs tweaks

Author: coretl

.github/workflows/docs.yml

@@ -36,15 +36,14 @@ jobs:
         with:
           msg: ${{ github.ref }}
           seperator: /
-          maxsplit: 2
 
       - name: Move to versioned directory
         # e.g. master or 0.1.2
         run: mv build/html ".github/pages/${{ steps.split.outputs._2 }}"
 
       - 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

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
 

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::