Build docs and push to gh-pages (#56)

* build docs and push to gh-pages test

* try creating folder ahead of time and setting write permissions

* try running container as root user

* don't use PWD

* move changes to main deploy workflow

Author: apulverizer

.github/workflows/build.yml

@@ -19,4 +19,4 @@ jobs:
     - name: Run tests
       run: docker run --user=allagash -v $PWD/tests:/home/allagash/tests -v $PWD/src-doc:/home/allagash/src-doc apulverizer/allagash:build /bin/bash -c "py.test --nbval"
     - name: Build documentation
-      run: docker run --user=allagash -v $PWD/src-doc:/home/allagash/src-doc apulverizer/allagash:build /bin/bash -c "sphinx-build -b html ./src-doc ./doc -a"
+      run: docker run --user=root -v $PWD/doc:/home/allagash/doc -v $PWD/src-doc:/home/allagash/src-doc apulverizer/allagash:build /bin/bash -c "sphinx-build -b html ./src-doc ./doc -a"

.github/workflows/deploy.yml

@@ -4,6 +4,9 @@ on:
   release:
     types: [published]
 
+permissions:
+  contents: write
+
 jobs:
   deploy:
     runs-on: ubuntu-latest
@@ -23,6 +26,16 @@ jobs:
       run: docker run --user=allagash -w /home/allagash/src apulverizer/allagash:build
         /bin/bash -c "twine upload -u __token__ -p $PYPI_API_TOKEN dist/*"
 
+    - name: Build docs
+      # Run as root so results can be saved to GHA runner host
+      run: docker run --user=root -v $PWD/doc:/home/allagash/doc -v $PWD/src-doc:/home/allagash/src-doc apulverizer/allagash:build /bin/bash -c "sphinx-build -b html ./src-doc ./doc -a"
+
+    - name: Deploy docs
+      uses: JamesIves/github-pages-deploy-action@v4
+      with:
+        folder: doc
+        branch: gh-pages
+
     - name: Build public docker image
       run: VERSION=$(docker run --user=allagash apulverizer/allagash:build /bin/bash -c "python -c 'import allagash;print(allagash.__version__)'")
         && docker build --build-arg VERSION=$VERSION . -t apulverizer/allagash:latest -t apulverizer/allagash:$VERSION