documentation.yaml

name: documentation check

on:
  push:
  pull_request:
    branches: [ "master", "dev" , "experimental" ]

jobs:
  readme_check:
    name: Readme check
    runs-on: ubuntu-latest
    steps:
    - name: Checkout code
      uses: actions/checkout@v5
    - name: Set up Python
      uses: actions/setup-python@v5
      with:
        python-version: '3.11'
    - name: Run script and save results
      run: python docs/script/make_doc.py README.tmp
    - name: Compare temp file with readme.rst
      run: diff -u --strip-trailing-cr README.rst README.tmp
  hon_examples_check:
    name: Check hon_example
    runs-on: ubuntu-latest
    steps:
    - name: Checkout code
      uses: actions/checkout@v5
    - name: Set up Python
      uses: actions/setup-python@v5
      with:
        python-version: '3.11'
    - name: Run script and save results
      run: python docs/script/process_examples.py docs/examples/hon_example.rst docs/hon_example.tmp
    - name: Compare temp file with hon_example.rst
      run: diff -u --strip-trailing-cr docs/hon_example.rst docs/hon_example.tmp
  smartair2_examples_check:
    name: Check smartair2_example
    runs-on: ubuntu-latest
    steps:
    - name: Checkout code
      uses: actions/checkout@v5
    - name: Set up Python
      uses: actions/setup-python@v5
      with:
        python-version: '3.11'
    - name: Run script and save results
      run: python docs/script/process_examples.py docs/examples/smartair2_example.rst docs/smartair2_example.tmp
    - name: Compare temp file with smartair2_example.rst
      run: diff -u --strip-trailing-cr docs/smartair2_example.rst docs/smartair2_example.tmp
  usb_2_uart_boards:
    name: Check usb_2_uart_boards
    runs-on: ubuntu-latest
    steps:
    - name: Checkout code
      uses: actions/checkout@v5
    - name: Set up Python
      uses: actions/setup-python@v5
      with:
        python-version: '3.11'
    - name: Run script and save results
      run: python docs/script/process_examples.py docs/examples/usb_2_uart_boards.rst docs/usb_2_uart_boards.tmp
    - name: Compare temp file with usb_2_uart_boards.rst
      run: diff -u --strip-trailing-cr docs/usb_2_uart_boards.rst docs/usb_2_uart_boards.tmp