docs-site.yml

name: Build & Deploy Docs Site (on-merge)

on:
  push:
    paths:
    - '.github/workflows/docs-site.yml'
    - 'docs/**'
    - 'mkdocs.yml'
    - 'mlcube/mlcube/__main__.py'
    - 'mlcube/mlcube/cli.py'

jobs:
  docs:
    runs-on: ubuntu-20.04
    steps:
      - uses: actions/checkout@v2
      - name: Set up Python
        uses: actions/setup-python@v2
        with:
          python-version: '3.8'
      - name: Install Python dependencies
        run: |
          python -m pip install --upgrade pip
          pip install -r docs/requirements.txt
      - name: Build Docs
        working-directory: './'
        run: |
          export PYTHONPATH=$(pwd)/mlcube:${PYTHONPATH}
          mkdocs build --site-dir ../site/
      - name: Deploy to GitHub Pages
        uses: peaceiris/actions-gh-pages@v3.6.4
        with:
          user_name: 'github-actions[bot]'
          user_email: 'github-actions[bot]@users.noreply.github.com'
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_dir: ../site
          allow_empty_commit: true