Merge pull request #38 from bparks13/main

Update ONIX Documentation

Author: jonnew

.github/workflows/gh-pages.yml

@@ -14,10 +14,10 @@ jobs:
 
       # 1. Generate HTML files
       - name: Check out repository code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
 
       - name: Setup Python
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: "3.10"
 
@@ -26,7 +26,7 @@ jobs:
           python -m pip install --upgrade pipenv wheel
 
       - id: cache-pipenv
-        uses: actions/cache@v1
+        uses: actions/cache@v4
         with:
           path: ~/.local/share/virtualenvs
           key: ${{ runner.os }}-pipenv-${{ hashFiles('**/Pipfile.lock') }}
@@ -43,7 +43,7 @@ jobs:
       # 2. Add and commit HTML files to gh-pages branch
       - name: Commit documentation changes
         run: |
-          git clone https://github.com/open-ephys/onix-docs.git --branch gh-pages --single-branch gh-pages
+          git clone https://github.com/${{ github.repository_owner }}/onix-docs.git --branch gh-pages --single-branch gh-pages
           cp -r docs/html/* gh-pages/
           cd gh-pages
           git config --local user.email "[email protected]"

README.rst

@@ -30,8 +30,8 @@ then you can build the documentation
 
    pipenv run make html
 
-if you want run ``make`` multiple times, prepend ``pipenv run`` on each command can be annoying,
-you can spawn a subshell with
+if you want to run ``make`` multiple times, prepending ``pipenv run`` on each command can be annoying.
+You can spawn a subshell with
 
 .. code:: shell