docs.yml

name: Documentation
on:
  push:
  pull_request:

jobs:

  run:
    runs-on: ubuntu-latest

    env:
      DJANGO_CA_SECRET_KEY: dummy

    steps:

      - name: Acquire sources
        uses: actions/checkout@v4.1.1

      - name: Setup Python
        uses: actions/setup-python@v5.0.0
        with:
          python-version: "3.12"
          architecture: x64

      - name: Apply caching of dependencies
        uses: actions/cache@v4.0.0
        with:
          path: ~/.cache/pip
          key: pip-${{ hashFiles('**/requirements-*.txt') }}

      - name: Install dependencies
        run: |
          pip install -U pip setuptools wheel
          pip install -r requirements.txt
          pip install -r requirements/requirements-docs.txt

      - name: doc8 style checks
        run: doc8 docs/source/

      - name: Generate documentation
        run: make -C docs html

      - name: Spelling
        run: make -C docs spelling