Merge pull request #72 from MunchLab/auto-deploy-docs

make docs deploy from gh-pages branch

Author: lizliz

.github/workflows/deploy_docs.yml

@@ -0,0 +1,44 @@
+name: Build and Deploy Documentation
+
+on:
+  push:
+    branches: ["master"]
+  workflow_dispatch:
+
+permissions:
+  contents: write
+
+jobs:
+  deploy-docs:
+    name: Build and deploy documentation to gh-pages
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.9"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install .
+          pip install sphinx sphinx-rtd-theme myst-parser nbsphinx matplotlib
+
+      - name: Build documentation
+        run: |
+          rm -rf docs
+          mkdir -p docs
+          sphinx-build -M html doc_source docs
+          rsync -a docs/html/ docs/
+          rm -rf docs/html
+          touch docs/.nojekyll
+
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./docs
+          publish_branch: gh-pages
+          force_orphan: true

.gitignore

@@ -72,6 +72,7 @@ instance/
 .scrapy
 
 # Sphinx documentation
+docs/
 docs/_build/
 
 # PyBuilder