docs-build.yml

name: docs-build

on:
  push:
    branches:
      - main
  workflow_dispatch:
  schedule:
    - cron: "0 4 * * *"

concurrency:
  group: docs-build-${{ github.ref }}
  cancel-in-progress: true

permissions: {}

jobs:
  docs:
    runs-on: ubuntu-latest
    permissions:
      contents: read
      actions: write
    env:
      # Skip pyquil notebook execution everywhere (including linkcheck, which
      # also executes notebooks) since no QVM/quilc servers run in CI.
      SKIP_PYQUIL: 1
    steps:
      - name: Check out mitiq
        uses: actions/checkout@v7

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

      - name: Set up Python
        uses: actions/setup-python@v6
        with:
          python-version: "3.12"

      - name: Install Python dependencies
        run: make install

      # - name: Run the quilc & qvm Docker images
      #   run: |
      #     docker run --rm -idt -p 5000:5000 rigetti/qvm -S
      #     docker run --rm -idt -p 5555:5555 rigetti/quilc -R

      - name: Generate hash from all files excluding example notebooks
        id: gen_hash
        run: |
          HASH=$(find . -type f -not -path './docs/source/examples/*' | sort | xargs cat | sha256sum | awk '{print $1}')
          echo "hash=$HASH" >> $GITHUB_OUTPUT

      - name: Fetch Jupyter cache
        uses: actions/cache@v6
        with:
          path: ./docs/build/.jupyter_cache
          key: jupyter-cache-${{ steps.gen_hash.outputs.hash }}

      - name: Build and test full Sphinx docs
        run: |
          sudo apt update
          sudo apt install ocl-icd-opencl-dev
          make docs

      - name: Run nightly linkcheck
        if: github.event_name == 'schedule'
        run: make linkcheck