api-docs.yaml

name: API Docs

# on:
#   push:
#     branches:
#       - <your-branch>
on:
  release:
    types:
      - published


permissions:
  contents: write

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-python@v5
        with:
          python-version: 3.x

      - uses: actions/cache@v3
        with:
          key: ${{ github.ref }}
          path: .cache

      - name: Install dependencies for doc generation
        run: |
            python -m pip install --upgrade pip
            pip install -r docs/_pydoc/requirements.txt
            pip install --upgrade setuptools # Fix to prevent: ModuleNotFoundError: No module named 'pkg_resources'


      - name: Generate API docs
        run: ./.github/utils/pydoc-markdown.sh


      - name: Configure git to push docs
        run: |
          git config --global user.name docs-bot
          git config --global user.email docs@bot.com
          git config pull.rebase false
          git pull --allow-unrelated-histories origin gh-pages

      - name: Install dependencies for doc deployment
        run: pip install mkdocs-material mkdocstrings[python] mkdocs-mermaid2-plugin mike

      - name: Publish docs
        run: |
          mike deploy --push --update-aliases ${{github.ref_name}} && \
          mike set-default --push ${{github.ref_name}}