name: Docs

on:

  pull_request:

    paths:

      - 'docs/**'

      - '.github/workflows/docs.yml'

  push:

    branches:

      - main

    paths:

      - 'docs/**'

      - '.github/workflows/docs.yml'

concurrency:

  group: ${{ github.workflow }}-${{ github.ref }}

  cancel-in-progress: true

jobs:

  docs:

    # OS must be the same as on djangoproject.com.

    runs-on: ubuntu-20.04

    name: docs

    steps:

      - name: Checkout

        uses: actions/checkout@v3

      - name: Set up Python

        uses: actions/setup-python@v3

        with:

          python-version: '3.10'

          cache: 'pip'

          cache-dependency-path: 'docs/requirements.txt'

      - run: python -m pip install -r docs/requirements.txt

      - name: Build docs

        run: |

          cd docs

          sphinx-build -b spelling -n -q -W --keep-going -d _build/doctrees -D language=en_US -j auto . _build/spelling