docs.yml

name: Build Docs and Publish to gh-pages
on:
  push:
    branches:
      - main
    paths:
      - "docs/**"
      - "mkdocs.yml"
      - "CHANGELOG.md"
  workflow_dispatch:
permissions:
  contents: write
jobs:
  publish_docs:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v4
      - name: Install poetry
        run: pipx install poetry
      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          python-version: "3.12"
      - name: Install dependencies
        run: make dev
      - name: Git client setup
        run: |
          git config user.name github-actions[bot]
          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
      - name: Build docs website and API reference
        run: mike set-default --push latest     
      - name: Deploy Docs
        run: mike deploy $(git rev-parse --short HEAD) latest --push
        # - run: mkdocs gh-deploy --force