From f12c4bd762e32842d5160f37e31b5ccf8a04c489 Mon Sep 17 00:00:00 2001 From: Lewis Chambers <47946387+lewis-chambers@users.noreply.github.com> Date: Thu, 30 May 2024 11:43:24 +0100 Subject: [PATCH] Create static.yml --- .github/workflows/static.yml | 58 ++++++++++++++++++++++++++++++++++++ 1 file changed, 58 insertions(+) create mode 100644 .github/workflows/static.yml diff --git a/.github/workflows/static.yml b/.github/workflows/static.yml new file mode 100644 index 0000000..e0d2c48 --- /dev/null +++ b/.github/workflows/static.yml @@ -0,0 +1,58 @@ +# Simple workflow for deploying static content to GitHub Pages +name: Deploy static content to Pages + +on: + # Runs on pushes targeting the default branch + push: + branches: ["documentation"] + + # Allows you to run this workflow manually from the Actions tab + workflow_dispatch: + +# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages +permissions: + contents: read + pages: write + id-token: write + +# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. +# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. +concurrency: + group: "pages" + cancel-in-progress: false + +jobs: + # Single deploy job since we're just deploying + deploy: + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v4 + - name: Setup Pages + uses: actions/configure-pages@v5 + - name: Set up Python + # This is the version of the action for setting up Python, not the Python version. + uses: actions/setup-python@v5 + with: + # Semantic version range syntax or exact version of a Python version + python-version: '3.12' + # Optional - x64 or x86 architecture, defaults to x64 + architecture: 'x64' + - name: Build Docs + run: | + pip install --upgrade pip + pip install .[docs] + pushd docs + . ./make.sh apidoc + . ./make.sh build + - name: Upload artifact + uses: actions/upload-pages-artifact@v3 + with: + # Upload entire repository + path: 'docs/_build' + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4