.github/workflows/docs.yaml
name: Build and deploy docs to Pages
on:
push:
tags:
- "v*.*.*"
workflow_dispatch:
concurrency:
group: "pages"
cancel-in-progress: true
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
with:
submodules: true
- name: Install poetry
run: pipx install poetry
- name: Setup Python
uses: actions/setup-python@v4
with:
python-version: "3.11"
cache: poetry
- name: Install dependencies
run: |
sudo apt install graphviz
poetry install --with docs
- name: Build pages
run: make -C docs html
- name: Upload artifact
uses: actions/upload-pages-artifact@v1
with:
path: docs/build/html/
deploy:
needs: build
permissions:
pages: write
id-token: write
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v1