Merge pull request #14 from chrislupp/develop

Release 0.3.0

.github/workflows/documentation.yaml

@@ -0,0 +1,45 @@
+name: Deploy Documentation
+
+# Only run this when the master branch changes
+on:
+  push:
+    branches:
+      - main
+    # If your git repository has the Jupyter Book within some-subfolder next to
+    # unrelated files, you can make this run only if a file within that specific
+    # folder has been modified.
+    #
+    # paths:
+    # - some-subfolder/**
+
+# This job installs dependencies, builds the book, and pushes it to `gh-pages`
+jobs:
+  deploy-book:
+    runs-on: ubuntu-latest
+    defaults:
+        run:
+          working-directory: doc
+    steps:
+    - uses: actions/checkout@v2
+
+    # Install dependencies
+    - name: Set up Python 3.9
+      uses: actions/setup-python@v2
+      with:
+        python-version: 3.9
+
+    - name: Install dependencies
+      run: |
+        pip install -r requirements.txt
+
+    # Build the book
+    - name: Build the book
+      run: |
+        jupyter-book build .
+
+    # Push the book's HTML to github-pages
+    - name: GitHub Pages action
+      uses: peaceiris/[email protected]
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        publish_dir: ./doc/_build/html

.github/workflows/tests.yaml

@@ -1,7 +1,7 @@
 # This workflow will install Python dependencies, run tests and lint with a variety of Python versions
 # For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
 
-name: Unit Tests
+name: Unit and Regression Tests
 
 on:
   push:

README.md

@@ -1,6 +1,6 @@
 ![Philote](doc/graphics/philote-python.svg)
 
-[![Unit Tests](https://github.com/chrislupp/Philote-Python/actions/workflows/tests.yaml/badge.svg?branch=main)](https://github.com/chrislupp/Philote-Python/actions/workflows/tests.yaml)
+[![Unit and Regression Tests](https://github.com/chrislupp/Philote-Python/actions/workflows/tests.yaml/badge.svg)](https://github.com/chrislupp/Philote-Python/actions/workflows/tests.yaml)
 # Philote-Python
 
 Python library for using and creating Philote analysis servers.