Skip to content

Trigger on branch

Trigger on branch #1

Workflow file for this run

name: Build and Deploy Documentation
on:
push:
branches: [ main, muhaawad/site ]
paths:
- 'docs/**'
- 'iris/**'
- 'examples/**'
- '.github/workflows/docs.yml'
pull_request:
branches: [ main, muhaawad/site ]
paths:
- 'docs/**'
- 'iris/**'
- 'examples/**'
permissions:
contents: read
pages: write
id-token: write
concurrency:
group: "pages"
cancel-in-progress: false
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: '3.10'
- name: Install system dependencies
run: |
sudo apt-get update
sudo apt-get install -y build-essential
- name: Install Python dependencies
run: |
python -m pip install --upgrade pip
pip install -r docs/sphinx/requirements.txt
pip install -e .
- name: Build documentation
run: |
cd docs
chmod +x build_docs.sh
./build_docs.sh
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: docs/_build/html
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
if: github.ref == 'refs/heads/main' || github.ref == 'refs/heads/muhaawad/site'
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4