Skip to content

Merge pull request #22 from calicarpa/documented_code #23

Merge pull request #22 from calicarpa/documented_code

Merge pull request #22 from calicarpa/documented_code #23

Workflow file for this run

name: Build and Deploy Documentation
on:
workflow_dispatch:
push:
branches: [main]
permissions:
contents: read
pages: write
id-token: write
concurrency:
group: "pages"
cancel-in-progress: false
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v6.0.2
- name: Install uv
uses: astral-sh/setup-uv@v8.1.0
with:
enable-cache: true
- name: Set up Python
uses: actions/setup-python@v6.2.0
with:
python-version-file: "pyproject.toml"
- name: Install dependencies
run: uv sync --extra dev
- name: Build documentation
run: uv run sphinx-build -b html docs docs/_build/html
- name: Upload artifact
uses: actions/upload-pages-artifact@v5.0.0
with:
path: docs/_build/html
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v5.0.0