doc.yml

name: Documentation

on:
  push:
    branches:
      - master
      - kvmi
      - kvmi-v6
      - kvmi-v7

jobs:
  build:
    runs-on: ubuntu-22.04

    strategy:
      matrix:
        kvmi_ver: [master, kvmi, kvmi-v6, kvmi-v7]

    steps:
      - uses: actions/checkout@v4
        with:
          ref: ${{ matrix.kvmi_ver }}

      - name: Set up Python
        uses: actions/setup-python@v5.2.0
        with:
          python-version: "3.10"

      - name: Install dependencies 📦
        run: pip install -r docs/requirements.txt

      - name: Build documentation 🔨
        run: sphinx-build -M html docs "docs/_build/${{ matrix.kvmi_ver }}"

      - uses: actions/upload-artifact@v4
        with:
          name: ${{ matrix.kvmi_ver }}
          path: "docs/_build/${{ matrix.kvmi_ver }}/html" 


  deploy:
    needs: build
    runs-on: ubuntu-latest
    permissions:
      contents: read
      packages: write

    steps:

      # the deploy action below depends on a checkout of the repo
      # otherwise it fails trying to remote the 'origin' remote
      # https://github.com/JamesIves/github-pages-deploy-action/issues/335
      - uses: actions/checkout@v4

      # download artifacts
      - uses: actions/download-artifact@v4
        with:
          name: master
          path: _web/master

      - uses: actions/download-artifact@v4
        with:
          name: kvmi
          path: _web/kvmi

      - uses: actions/download-artifact@v4
        with:
          name: kvmi-v6
          path: _web/kvmi-v6

      - uses: actions/download-artifact@v4
        with:
          name: kvmi-v7
          path: _web/kvmi-v7

      # add .nojekyll to the root so that github won't 404 on content added to dirs
      # that start with an underscore (_), such as our "_content" dir..
      - name: Add nojekyll for Github Pages
        run: touch _web/.nojekyll

      - name: Deploy 🚀
        uses: JamesIves/github-pages-deploy-action@v4
        with:
          # note: FOLDER doesn't care about the job's working directory
          folder: _web
          single-commit: true