From c0da6ea4b76e675f64a0ec7a27bc4e399a27ae0d Mon Sep 17 00:00:00 2001 From: Simon Briere Date: Mon, 30 Oct 2023 11:00:57 -0400 Subject: [PATCH] Refs #91. Added Github action to deploy docs. --- .../gen-doc-and-deploy-to-github-pages.yml | 31 +++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 .github/workflows/gen-doc-and-deploy-to-github-pages.yml diff --git a/.github/workflows/gen-doc-and-deploy-to-github-pages.yml b/.github/workflows/gen-doc-and-deploy-to-github-pages.yml new file mode 100644 index 00000000..32f290cc --- /dev/null +++ b/.github/workflows/gen-doc-and-deploy-to-github-pages.yml @@ -0,0 +1,31 @@ +name: gen-doc-and-deploy-to-github-pages + +on: + push: + branches: [main] + workflow_dispatch: + branches: [main] + +jobs: + build: + + runs-on: ubuntu-latest + strategy: + matrix: + python-version: [3.11.4] + + steps: + - name: Generate base documentation + working-directory: docs + run: | + pip install -r requirements.txt + make html + touch _build/html/.nojekyll + + - name: Deploy to GitHub Pages + uses: JamesIves/github-pages-deploy-action@3.7.1 + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + branch: gh-pages + folder: docs/_build/html +