docs.yml

name: Build docs

on:
  push:
    branches:
        - main
  pull_request:
    branches:
        - main
    types: [opened, synchronize, reopened, ready_for_review]
  workflow_dispatch:

jobs:
  build-docs:
    if: github.event.pull_request.draft == false || github.event_name != 'pull_request'
    permissions: 
        contents: write
    runs-on: ubuntu-latest
    steps:
      - name: Checkout 🛎️
        uses: actions/checkout@v3
      - name: Set up Python 🐍
        uses: actions/setup-python@v3
        with:
          python-version: 3.12
      - name: Install dependencies 🛠️
        run: |
          python -m pip install --upgrade pip
          python -m pip install mkdocs mkdocs-autoapi mkdocs-include-markdown-plugin mkdocstrings[python] mkdocs-render-swagger-plugin
      - name: Build docs 📖
        run: mkdocs build
      - name: Deploy docs 🚀
        if: ${{ github.event_name == 'push' }}
        uses: JamesIves/github-pages-deploy-action@v4
        with:
          folder: site