check-docs-build.yml

name: check docs build

on:
  pull_request:
    branches:
      - main
  schedule:
    # 03:00 every Saturday morning
    - cron: '0 3 * * 6'

jobs:

  changes:
    runs-on: ubuntu-22.04
    outputs:
      manual: ${{ steps.filter.outputs.manual }}
    steps:
    - uses: actions/checkout@v4
    - uses: dorny/paths-filter@v3
      id: filter
      with:
        base: ${{ github.ref }}
        filters: |
          manual:
            - 'manual/**'
            - 'manual_requirements.txt'
            - 'manual_constraints.txt'
            - '.github/**'

  check:
    name: check docs build
    needs: changes
    if: github.event_name == 'schedule' || needs.changes.outputs.manual == 'true'
    runs-on: ubuntu-22.04
    steps:
    - uses: actions/checkout@v4
      with:
        submodules: true
        fetch-depth: '0'
    - run: git fetch --depth=1 origin +refs/tags/*:refs/tags/* +refs/heads/*:refs/remotes/origin/*
    - name: Set up Python 3.11
      uses: actions/setup-python@v5
      with:
        python-version: 3.11
    - name: install python requirements for docs
      run: |
        python -m pip install poetry
        poetry install
    - name: install graphviz
      run: |
          sudo apt-get update
          sudo apt-get install graphviz
    - name: build manual and examples
      run: |
        poetry run ./build-docs.sh