docs.yml

name: docs

on: push

defaults:
  run:
    working-directory: docs/

jobs:
  build-docs:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - uses: actions/setup-python@v2
        with:
          python-version: '3.x'

      - run: pip install -r requirements.txt
      - run: mkdocs build

      - uses: actions/upload-artifact@v2
        with:
          name: built-docs
          path: docs/build/


  deploy-gh-pages:
    if: github.ref == 'refs/heads/main'
    needs: build-docs
    runs-on: ubuntu-latest
    steps:
      - uses: actions/download-artifact@v2
        with:
          name: built-docs
          path: docs/build/

      - name: Deploy
        uses: peaceiris/actions-gh-pages@v3
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_branch: gh-pages
          publish_dir: docs/build/
          enable_jekyll: false
          commit_message: Deploy from GitHub Actions