Skip to content

Added .github/workflows/publish.yml (#17) #12

Added .github/workflows/publish.yml (#17)

Added .github/workflows/publish.yml (#17) #12

Workflow file for this run

name: Deploy docs to GitHub Pages
on:
push:
branches: ["devel", "main"] # TODO: Set to main only after release
workflow_dispatch:
permissions:
contents: read
pages: write
id-token: write
concurrency:
group: "pages"
cancel-in-progress: false
jobs:
build-and-deploy:
runs-on: ubuntu-latest
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Install pandoc
run: |
sudo apt-get update
sudo apt-get install -y pandoc
- name: Install Python dependencies
run: |
python -m pip install --upgrade pip
pip install ".[docs]"
- name: Build Sphinx docs
run: |
cd docs
make html
- name: Setup Pages
uses: actions/configure-pages@v5
- name: Upload built docs
uses: actions/upload-pages-artifact@v3
with:
path: docs/build/html/
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4