Skip to content

Wrapper

Wrapper #25

Workflow file for this run

name: documentation
on:
workflow_dispatch:
push:
branches: [ main ]
pull_request:
branches: [ main ]
# 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:
build-docs:
runs-on: [ubuntu-latest]
container: python:3.10-bookworm
steps:
- uses: actions/checkout@v4
- name: Install dependencies
run: |
apt-get update
apt-get -y install xvfb pandoc
python -m pip install --upgrade pip setuptools setuptools_scm wheel
pip install -e .[docs]
pip install -r docs/requirements.txt
- name: Build documentation
run: |
sphinx-build -b html docs/ _site
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
# Deployment job
deploy-docs:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
if: github.ref_name == 'main'
needs: build-docs
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4