first attempt at gh-pages

Author: zingale

.github/workflows/gh-pages.yml

@@ -0,0 +1,44 @@
+name: github pages
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  deploy:
+    runs-on: ubuntu-20.04
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+      - name: Install pandoc and doxygen 
+        run: |
+          sudo apt install pandoc doxygen
+
+      - name: Setup Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: '3.8'
+
+      - name: Cache pip
+        uses: actions/cache@v2
+        with:
+          # this path is specific to Ubuntu
+          path: ~/.cache/pip
+          key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
+          restore-keys: |
+            ${{ runner.os }}-pip-
+
+      - name: Install dependencies
+        run: pip install -r ./requirements.txt
+
+      - name: Build docs
+        run: ./deploy_docs_action.sh
+
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./out
+          keep_files: true

.nojekyll

@@ -0,0 +1,12 @@
+#!/bin/bash
+set -e # Exit with nonzero exit code if anything fails
+
+mkdir out
+
+# Build the Sphinx documentation
+cd docs
+make html
+cd ../
+
+mkdir -p out/
+mv docs/build/html/* out/

deploy_docs_action.sh

@@ -0,0 +1,4 @@
+matplotlib>=2.1.0
+sphinx_rtd_theme
+Sphinx
+nbsphinx>=0.3.1