docs.yaml

name: docs

on:
  push:
    branches: [main]
  workflow_dispatch:

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

concurrency:
  group: pages
  cancel-in-progress: true

env:
  # Keep in step with test.yml's pin -- docs runs `mojo doc`, which compiles the
  # sources and so breaks on the same stdlib changes the tests do.
  MOJO_VERSION: "1.0.0"

jobs:
  build-deploy:
    runs-on: ubuntu-latest
    timeout-minutes: 15
    environment:
      name: github-pages
      url: ${{ steps.deploy.outputs.page_url }}
    steps:
      - uses: actions/checkout@v4

      - name: Install uv
        uses: astral-sh/setup-uv@v5

      - name: Install Mojo
        run: |
          uv venv
          uv pip install "mojo==$MOJO_VERSION"

      - name: Generate API reference
        run: |
          .venv/bin/mojo doc -o docs/api.json -I src src/diff
          python3 docs/render_api.py docs/api.json docs/site/index.html

      - name: Upload Pages artifact
        uses: actions/upload-pages-artifact@v3
        with:
          path: docs/site

      - name: Deploy to GitHub Pages
        id: deploy
        uses: actions/deploy-pages@v4