docs.yml

name: Documentation

on:
  push:
    branches: [ main ]
    paths:
      - 'docs/**'
      - 'bw_admin/**/*.py'
  workflow_dispatch:

jobs:
  check-docs:
    name: Check Documentation
    runs-on: ubuntu-latest

    steps:
    - name: Checkout code
      uses: actions/checkout@v4

    - name: Set up Python
      uses: actions/setup-python@v4
      with:
        python-version: '3.10'

    - name: Install dependencies
      run: |
        python -m pip install --upgrade pip
        pip install -r requirements-dev.txt

    - name: Check documentation links
      run: |
        # Check for broken links in markdown files
        find docs -name "*.md" -type f | while read file; do
          echo "Checking $file"
          grep -o '\[.*\](.*)' "$file" || true
        done

    - name: Generate API documentation (if sphinx configured)
      run: |
        if [ -f "docs/conf.py" ]; then
          cd docs
          make html
        else
          echo "Sphinx not configured yet - skipping"
        fi
      continue-on-error: true

  markdown-lint:
    name: Markdown Linting
    runs-on: ubuntu-latest

    steps:
    - name: Checkout code
      uses: actions/checkout@v4

    - name: Markdown lint
      uses: articulate/actions-markdownlint@v1
      with:
        config: .markdownlint.json
        files: 'docs/**/*.md'
        ignore: node_modules
      continue-on-error: true