docs.yml

name: Deploy Documentation

on:
  push:
    branches: [main]
    paths:
      - 'docs/**'
      - 'mkdocs.yml'
      - '.github/workflows/docs.yml'
      - 'README.md'
      - 'CHANGELOG.md'
      - 'CONTRIBUTING.md'
      - 'ROADMAP.md'
      - 'LICENSE'
  workflow_dispatch:

permissions:
  contents: write

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v6
        with:
          fetch-depth: 0  # Fetch all history for git info

      - name: Setup Python
        uses: actions/setup-python@v6
        with:
          python-version: '3.11'

      - name: Install dependencies
        run: |
          pip install mkdocs-material
          pip install mkdocs-autorefs

      - name: Copy files to docs
        run: |
          cp CHANGELOG.md docs/
          cp LICENSE docs/LICENSE.md
          cp CONTRIBUTING.md docs/
          cp ROADMAP.md docs/

      - name: Build documentation
        run: mkdocs build --strict

      - name: Deploy to GitHub Pages
        # CNAME file in docs/ dir will be deployed automatically
        run: mkdocs gh-deploy --force