docs.yml

name: documentation

on:
  create:
    tags:
    - v*
  push:
    paths:
    - docs/**
    - .github/workflows/docs.yml
    - tasks/docs.py
    - mkdocs.yml
    - tox.ini
  pull_request:
    paths:
    - docs/**
    - .github/workflows/docs.yml
    - tasks/docs.py
    - mkdocs.yml
    - tox.ini

jobs:
  build:
    name: Build Docs
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v3

    - name: Fetch Tags
      run: git fetch --depth=1 origin +refs/tags/*:refs/tags/*

    - name: Set up Python 3.8
      uses: actions/setup-python@v4
      with:
        python-version: "3.8"

    - name: Install dependencies
      run: |
        python -m pip install --upgrade pip setuptools
        python -m pip install --upgrade -r requirements.txt

    - name: Build docs
      run: |
        invoke docs.build

    - uses: actions/upload-artifact@v3
      with:
        name: Documentation
        path: site

  publish:
    name: Publish Docs
    runs-on: ubuntu-latest
    # Only publish tags
    if: github.event_name == 'create' && github.event.ref_type == 'tag'
    needs:
      - build
    steps:
      - uses: actions/download-artifact@v3
        with:
          name: Documentation
          path: site

      - name: Publish generated content to GitHub Pages
        uses: peaceiris/actions-gh-pages@v3
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_dir: ./site