photonvision-docs.yml

name: PhotonVision Sphinx Documentation Checks

on:
  push:
    branches: [ master ]
  pull_request:
    branches: [ master ]
  merge_group:

env:
  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

jobs:
  changed:
    runs-on: ubuntu-22.04
    # Required permissions
    permissions:
      pull-requests: read
    # Set job outputs to values from filter step
    outputs:
      docs: ${{ steps.filter.outputs.docs == 'true' || steps.filter.outputs.workflow == 'true' || github.event_name != 'pull_request' }}
      code: ${{ steps.filter.outputs.code == 'true' || steps.filter.outputs.workflow == 'true' || github.event_name != 'pull_request' }}
    steps:
      - uses: actions/checkout@v4
        if: github.event_name != 'pull_request'
      - name: Check for file changes
        uses: dorny/paths-filter@v2
        id: filter
        with:
          list-files: 'shell'
          filters: |
            docs:
              - 'docs/**'
            workflow:
              - '.github/**'
            code:
              - 'photon-*/**'


  build:
    name: "Build Sphinx docs in Actions"
    runs-on: ubuntu-22.04

    needs: changed
    if: needs.changed.outputs.docs== 'true'

    steps:
    - uses: actions/checkout@v4

    - uses: actions/setup-python@v4
      with:
        python-version: '3.11'

    - name: Install and upgrade pip
      run: python -m pip install --upgrade pip

    - name: Install graphviz
      run: |
        sudo apt-get update
        sudo apt-get -y install graphviz

    - name: Install Python dependencies
      working-directory: docs
      run: |
        pip install sphinx sphinx_rtd_theme sphinx-tabs sphinxext-opengraph doc8
        pip install -r requirements.txt

    - name: Check links
      working-directory: docs
      run: make linkcheck
      continue-on-error: true

    - name: Check lint
      working-directory: docs
      run: make lint

    - name: Compile HTML
      working-directory: docs
      run: make html