name: Check Links in Documentation
on:
  schedule:
    # First day of month at 05:46 in every 2nd month
    - cron: '46 5 1 */2 *'
  pull_request:
    paths:
      - .github/workflows/docs-linkcheck.yml

jobs:
  test-sphinx-build:
    name: test-sphinx-linkcheck
    runs-on: ${{matrix.os}}
    strategy:
      matrix:
        python-version: ['3.10']
        os: [ubuntu-latest]
      fail-fast: False
    steps:
      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
        with:
          persist-credentials: false
      - name: Set up Python ${{ matrix.python-version }}
        uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # v5.3.0
        with:
          python-version: ${{ matrix.python-version }}
      - name: Install dependencies
        run: |
          python -W ignore -m pip install --upgrade pip
          python -W ignore -m pip install -r requirements-dev-all.txt
      - name: Check Links
        run: sphinx-build docs/source docs/build/html -W --keep-going -j auto -b linkcheck