test-docs.yml

name: Test

on:
    push:
        branches:
            - main
    pull_request:
        branches:
            - main
    schedule:
        - cron: "0 0 * * *"

jobs:
    docs:
        runs-on: ubuntu-latest
        steps:
            - uses: actions/checkout@v4
              with:
                  fetch-depth: 0
            - uses: actions/setup-python@v5
              with:
                  python-version: 3.x
            - name: Check docs links
              uses: umbrelladocs/action-linkspector@v1
              with:
                  github_token: ${{ secrets.github_token }}
                  reporter: github-pr-review
                  fail_on_error: true
            - name: Check docs build
              run: |
                  pip install -r requirements/build-docs.txt
                  cd docs
                  mkdocs build --strict
            - name: Check docs examples
              run: |
                  pip install -r requirements/check-types.txt
                  pip install -r requirements/check-style.txt
                  mypy --show-error-codes docs/examples/python/
                  ruff check docs/examples/python/