docs.yml

name: Documentation
on:
  push:
    branches:
      - main
    paths:
      - 'docs/**'
  # Build pull requests
  pull_request:
    paths:
      - 'docs/**'
      - 'styles/**'

jobs:
  docs:
    name: Documentation
    runs-on: ubuntu-latest
    strategy:
      matrix:
        python-version: ['3.10']
    steps:
      - uses: actions/checkout@v3

      - name: Set up Python ${{ matrix.python-version }}
        uses: actions/setup-python@v4
        with:
          python-version: ${{ matrix.python-version }}
          cache: 'pip'

      - name: Create Python virtual environment
        run: pip install virtualenv

      - name: pip install requirements
        run: pip install -r requirements-docs.txt

      - name: Check for broken links
        run: make docs-linkcheckbroken

      - name: Build HTML documentation
        run: make docs-html

      # Disable GHA vale checking, it started to fail with a gazillion of
      # violations. We need to review it closely
      # - uses: errata-ai/vale-action@reviewdog
      #   with:
      #     # debug: true
      #     files: all
      #   env:
      #     # Required, set by GitHub actions automatically:
      #     # https://docs.github.com/en/actions/security-guides/automatic-token-authentication#about-the-github_token-secret
      #     GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}