Skip to content

Build and deploy docs #104

Build and deploy docs

Build and deploy docs #104

name: Build and deploy docs
on:
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# Cancels jobs that are in progress if a new job arrives.
concurrency:
group: "pages"
cancel-in-progress: true
jobs:
# Build documentation
build:
runs-on: ubuntu-latest
permissions:
contents: read
id-token: write
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup PDM
uses: pdm-project/setup-pdm@v4
with:
python-version: '3.12'
- name: Install default and doc dependencies
run: pdm install --group doc --frozen-lockfile
- name: Build HTML
run: |
cd docs/
pdm run make dirhtml
- name: Upload artifact
with:
path: docs/build/dirhtml
uses: actions/upload-pages-artifact@v3
# Deployment job
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
permissions:
pages: write
id-token: write
needs: build
steps:
- name: Setup Pages
uses: actions/configure-pages@v5
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4