Skip to content

chore: update license date #88

chore: update license date

chore: update license date #88

Workflow file for this run

name: Deploy Sphinx documentation to Pages
on:
# TEMPORARY: Deploy from current branch for testing
push:
branches:
- main
- 195-improve-documentation-page-generating-it-automatically # Testing branch
# Deploy when a new release is published
release:
types: [published]
# Build check on PRs (no deployment)
pull_request:
# Allow manual trigger
workflow_dispatch:
permissions:
contents: write
pages: write
id-token: write
concurrency:
group: "pages"
cancel-in-progress: false
jobs:
docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Install Pandoc
run: |
sudo apt-get update
sudo apt-get install -y pandoc
- name: Setup Python
uses: actions/setup-python@v5
with:
python-version: '3.13'
- name: Install uv
uses: astral-sh/setup-uv@v6
- name: Install Task (taskfile.dev)
uses: arduino/setup-task@v2
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- name: Print versions
run: |
python --version
uv --version
task --version
- name: Install dependencies
run: task install
- name: Build documentation
run: |
task docs:html-all
# Only upload and deploy if NOT a pull request
- name: Upload artifact
if: github.event_name != 'pull_request'
uses: actions/upload-pages-artifact@v3
with:
path: ./docs/_build/html
- name: Deploy to GitHub Pages
if: github.event_name != 'pull_request'
id: deployment
uses: actions/deploy-pages@v4
# On PR: just verify the build worked
- name: PR Check - Documentation built successfully
if: github.event_name == 'pull_request'
run: |
echo "✅ Documentation builds successfully!"
echo "📝 Docs will be deployed when this PR is merged to main"