docs.yaml

name: Build HTML and PDF documentation

on:
  push:
    branches: ["master"]
    paths:
      - "docs/**"
  workflow_dispatch:

permissions:
  contents: read
  pages: write
  id-token: write

concurrency:
  group: "pages"
  cancel-in-progress: false

jobs:
  # Build job
  build:
    runs-on: ubuntu-24.04
    steps:
      - name: Checkout repo
        uses: actions/checkout@v4
      - name: Set up Python
        uses: actions/setup-python@v5
      - name: Install uv
        uses: astral-sh/setup-uv@v4
      - name: Build HTML docs
        run: make html
        working-directory: ./docs
      # - name: Build PDF docs
      #   run: make pdf
      #   working-directory: ./docs
      # - uses: xu-cheng/texlive-action@v2
      #   with:
      #     scheme: full
      #     run: |
      #       apk add make
      #       make -C ./docs/build/pdf
      - name: Upload GH pages artifacts
        uses: actions/upload-pages-artifact@v3
        with:
          path: ./docs/build/html
      # - name: Upload PDF artifact
      #   uses: actions/upload-artifact@v4
      #   with:
      #     name: docs-pdf
      #     path: ./docs/build/pdf/minimalrisc-vsoc.pdf
      #     compression-level: 0
  # Deployment job
  deploy:
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-24.04
    needs: build
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4