docs.yml

name: Publish documentation

on:
  push:
    branches:
      - main
      - gh-pages
    tags:
      - "**"

jobs:
  publish:
    runs-on: ubuntu-latest
    steps:
      - name: checkout docs-site
        uses: actions/checkout@v4
        with:
          ref: gh-pages

      - uses: actions/checkout@v4

      - name: Setup Python
        uses: actions/setup-python@v4
        with:
          python-version: ${{ matrix.python-version }}
          # Looks like it's not working very well for other people:
          # https://github.com/actions/setup-python/issues/436
          # cache: "pip"
          # cache-dependency-path: pyproject.toml

      - uses: actions/cache@v3
        id: cache
        with:
          path: ${{ env.pythonLocation }}
          key: ${{ runner.os }}-python-${{ env.pythonLocation }}-${{ hashFiles('pyproject.toml') }}-docs

      - name: Install dependencies
        if: steps.cache.outputs.cache-hit != 'true'
        run: pip install -e .[docs]

      - name: Set git credentials
        run: |
          git config --global user.name "${{ github.actor }}"
          git config --global user.email "${{ github.actor }}@users.noreply.github.com"

      - run: mike deploy dev --push
        if: github.ref == 'refs/heads/main'

      - run: mike deploy ${{ github.ref_name }} latest --update-aliases --push
        if: startsWith(github.ref, 'refs/tags/')