documentation.yml

name: Create Documentation 📚

on:
  push:
    branches:
      - master

jobs:
  # Build the documentation
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      
      - name: Copy Files
        run: |
          cp README.md Docfx/index.md
          cp -r Resources Docfx/Resources

      - uses: nunit/docfx-action@v4.1.0
        name: Build Documentation
        with:
          args: Docfx/docfx.json

      - name: Upload site artifact
        uses: actions/upload-artifact@v4
        with:
          name: Documentation
          path: _site

  # Deploy the generated documentation to the gh-pages branch
  deploy:
    needs: build
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v4
        
      # Download the generated documentation
      - name: Download site artifact
        uses: actions/download-artifact@v4
        with:
          name: Documentation
          path: docs

      - name: Deploy
        uses: peaceiris/actions-gh-pages@v4
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_branch: gh-pages
          publish_dir: docs