documentation.yml

name: documentation

on:
  push:
    branches:
      - master
  pull_request:
    branches:
      - master

jobs:
  build:
    runs-on: ${{ matrix.os }}
    strategy:
      fail-fast: false
      matrix:
        os: [ubuntu-latest]
        python-version: [3.7]

    steps:
      - name: Copy Repository Contents ↩
        uses: actions/checkout@v2
        with:
          persist-credentials: false
      - name: Set up Python ${{ matrix.python-version }} 🚜
        uses: actions/setup-python@v2
        with:
          python-version: ${{ matrix.python-version }}
      - name: Install dependencies 🛠
        run: |
          python -m pip install --upgrade pip
          pip install mkdocs mkdocs-material mkdocstrings mkdocstrings-python mknotebooks Pygments livereload
          if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
          pip install .
      - name: Build documentation 👷‍♀️
        run: |
          mkdocs build
      - name: Predeploy on PR ✈️
        if: github.event_name == 'pull_request'
        uses: JamesIves/github-pages-deploy-action@4.0.0
        with:
          folder: site
          target-folder: "predeploy"
          token: ${{ secrets.DOC_ACCESS_TOKEN }}
          branch: master
          commit-message: "PR predeploy"
          repository-name: neurolib-dev/neurolib-dev.github.io
      - name: Deploy 🚀
        if: github.event_name == 'push'
        uses: JamesIves/github-pages-deploy-action@4.0.0
        with:
          folder: site
          token: ${{ secrets.DOC_ACCESS_TOKEN }}
          branch: master
          repository-name: neurolib-dev/neurolib-dev.github.io