docs.yaml

---
name: Documentation Check

on:
  push:
    branches:
      - main
  pull_request:
    branches:
      - main

jobs:
  check-api-docs:
    runs-on: ubuntu-latest

    steps:
      - name: Check out repository
        uses: actions/checkout@v4

      - name: Set up environment
        uses: ./.github/actions/setup/poetry
        with:
          os: ${{ job.os }}
          python-version: '3.11'
          poetry-install-options: ""
          poetry-export-options: ""

      - name: List all the deps for debugging
        run: |
          poetry show --tree

      # - name: Generate API docs
      #   run: |
      #     sphinx-apidoc -o /tmp/docs tus_storagehandler/

      # - name: Compare docs with main branch
      #   id: check_docs_diff
      #   run: |
      #     shasum /tmp/docs/* > /tmp/docs.sha
      #     shasum /docs/pages/* > /docs/project_doc.sha
      #     diff=$(diff /tmp/docs.sha /docs/project_doc.sha) || true
      #     if [[ -n "$diff" ]]; then
      #       echo "::error::API documentation is out of date."
      #       exit 1
      #     else
      #       echo "API documentation is up to date."
      #     fi
...