name: docs

on: ["push", "pull_request"]

jobs:
  docs:
    # We want to run on external PRs, but not on our own internal PRs as they'll be run
    # by the push to the branch.
    if: github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository

    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - name: Setup Python
        uses: actions/setup-python@v5
        with:
          python-version: '3.x'
          cache: "pip"
          cache-dependency-path: |
            requirements.txt
            docs/requirements.txt

      - name: Build
        run: |
          pip install -r requirements.txt
          make cython

      - name: Sphinx Documentation Generator
        run: |
          pip install -r docs/requirements.txt
          make docs
