Skip to content

bugfix: swapped color channels when visualizing prediction sample (no… #484

bugfix: swapped color channels when visualizing prediction sample (no…

bugfix: swapped color channels when visualizing prediction sample (no… #484

Workflow file for this run

name: Build documentation
on:
workflow_dispatch: # run on request (no need for PR)
push:
branches:
- main
paths-ignore:
- ".github/**" # Ignore changes towards the .github directory
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write
# Allow one concurrent deployment
concurrency:
group: "pages"
cancel-in-progress: true
jobs:
build_docs:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- name: Harden Runner
uses: step-security/harden-runner@cb605e52c26070c328afc4562f0b4ada7618a84e # v2.10.4
with:
egress-policy: audit
- name: Checkout repository
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
- name: Set up Python
uses: actions/setup-python@42375524e23c412d93fb67b49958b491fce71c38 # v5.4.0
with:
python-version: 3.12
- name: Install package with dev, notebooks and docs requirements
run: |
pip install ".[dev,notebooks]" --pre
pip install -r requirements/requirements-docs.txt
- name: Build sphinx documentation
# We build twice to ensure that all references are resolved
run: |
cd docs
make html
make html
cd ..
- name: Clean up repo directory
run: |
mkdir -p /tmp/docs_build
cp -r docs/build/html/* /tmp/docs_build
rm -rf ./*
# git fetch && git pull
# git checkout gh-pages
cp -r /tmp/docs_build/* ./
rm -rf /tmp/docs_build
touch .nojekyll
# git config --local user.email "[email protected]"
# git config --local user.name "GitHub Action"
# git add .
# git commit -m "Update documentation" -a || true
# The above command will fail if no changes were present, so we ignore
# the return code.
- name: Setup Pages
uses: actions/configure-pages@983d7736d9b0ae728b81ab479565c72886d7745b # v5.0.0
- name: Upload artifact
uses: actions/upload-pages-artifact@56afc609e74202658d3ffba0e8f6dda462b719fa # v3.0.1
with:
# Upload entire repository
path: '.'
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e # v4.0.5