Skip to content

Build triggered by Pull Request 29 on branch main #29

Build triggered by Pull Request 29 on branch main

Build triggered by Pull Request 29 on branch main #29

Workflow file for this run

name: Build, run tests and deploy GitHub Pages
run-name: Build triggered by Pull Request ${{github.event.number}} on branch main
on:
pull_request:
types: [closed]
branches:
- main
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: write
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:
documentation:
runs-on: ubuntu-latest
if: github.event.pull_request.merged
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Python
uses: actions/setup-python@v5
with:
python-version: "3.12" # install the python version needed
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install sphinx sphinx-thebe sphinx_book_theme myst_parser sphinx_mdinclude
- name: Sphinx build
run: |
sphinx-build documentation/source documentation/build
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v4
with:
publish_branch: gh-pages
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: documentation/build/
force_orphan: true