docs.yml

name: Build & Deploy Docs

on:
  workflow_dispatch:
  pull_request:
    branches:
      - dev
    paths:
      - 'docs/**'
      - 'src/**'
      - 'mkdocs.yml'
  push:
    branches:
      - main
    paths:
      - 'docs/**'
      - 'src/**'
      - 'mkdocs.yml'

permissions:
  contents: read
  pages: write
  id-token: write

jobs:
  build_mkdocs:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v7
        with:
          fetch-depth: 0
      - name: Setup Python
        uses: actions/setup-python@v7
        with:
          python-version: '3.9'
      - name: Install packages with pip
        run: |
          pip install 'mkdocs-material[imaging]' 'mkdocstrings[python]' 
          pip install mkdocs-git-revision-date-localized-plugin mkdocs-git-committers-plugin-2
      - name: Build with MkDocs
        run: mkdocs build --config-file mkdocs.yml
      - name: Upload artifact
        uses: actions/upload-pages-artifact@v5
        with:
          path: site/
  deploy_mkdocs:
    if: ${{ github.event_name != 'pull_request' }}
    needs: build_mkdocs
    environment:
      name: github-pages
      url: https://mkh-user.github.io/graphite
    runs-on: ubuntu-latest
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v5