Merge pull request #3 from ARCTraining/reformat-jbbook

add github actions for deployment

.github/workflows/deploy-book.yml

@@ -0,0 +1,35 @@
+# copied from https://jupyterbook.org/publish/gh-pages.html?highlight=github%20pages
+
+name: deploy-book
+
+# Only run this when the master branch changes
+on:
+  push:
+    branches:
+    - main
+
+# This job installs dependencies, build the book, and pushes it to `gh-pages`
+jobs:
+  deploy-book:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: conda-incubator/setup-miniconda@v2
+      with:
+        environment-file: environment.yml
+        auto-activate-base: false
+        activate-environment: arcdocs-jb
+
+    # Build the book
+    - name: Build the book
+      shell: bash -l {0}
+      run: |
+        conda activate arcdocs-jb
+        jupyter-book build ./book/
+    # Push the book's HTML to master branch (because this is an organisation homepage)
+    - name: GitHub Pages action
+      uses: peaceiris/[email protected]
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        publish_dir: ./book/_build/html
+        publish_branch: gh-pages

.github/workflows/test-build.yml

@@ -0,0 +1,33 @@
+# copied from https://jupyterbook.org/publish/gh-pages.html?highlight=github%20pages
+
+name: test-build
+
+# Only run this when a PR suggests changes to main branch
+on:
+  pull_request:
+    branches:
+      - main
+
+# This job installs dependencies and builds the book
+jobs:
+  deploy-book:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      # test build on multiple OS
+      matrix:
+        os: [macos-latest, windows-latest, ubuntu-latest]
+    steps:
+    - uses: actions/checkout@v2
+    - uses: conda-incubator/setup-miniconda@v2
+      with:
+        environment-file: environment.yml
+        auto-activate-base: false
+        activate-environment: arcdocs-jb
+
+    # Build the book
+    - name: Build the book
+      shell: bash -l {0}
+      run: |
+        conda activate arcdocs-jb
+        jupyter-book build ./book/
+

book/_config.yml

@@ -1,5 +1,5 @@
 # Book settings
-title: SWD5: Scientific Python
+title: "SWD5: Scientific Python"
 author: University of Leeds Research Computing Team
 logo: ./assets/img/logo/logo.png
 email: [email protected]