docs.yml

name: Docs

on:
  push:
    branches: [master, develop]
  pull_request:
    branches: [master, develop]

jobs:
  build_docs:
    runs-on: ${{ matrix.os }}
    strategy:
      fail-fast: true
      matrix:
        os: [ubuntu-latest]
        python-version: ["3.9"]

    steps:
      - uses: actions/checkout@v3

      - name: Create local data folder
        run: |
          mkdir ~/mne_data

      - name: Setup Python
        uses: actions/setup-python@v4
        with:
          python-version: ${{ matrix.python-version }}

      - name: Install Poetry
        uses: snok/install-poetry@v1
        with:
          virtualenvs-create: true
          virtualenvs-in-project: true

      - name: Cache datasets and docs
        id: cached-dataset-docs
        uses: actions/cache@v3
        with:
          key: doc-${{ github.head_ref }}-${{ hashFiles('moabb/datasets/**') }}
          path: |
            ~/mne_data
            docs/build

      - name: Install dependencies
        if: steps.cached-dataset-docs.outputs.cache-hit != 'true'
        run: poetry install --no-interaction --no-root --with docs,deeplearning

      - name: Install library
        run: poetry install --no-interaction --with docs,deeplearning

      - name: Build docs
        run: |
          cd docs && poetry run make html

      # Create an artifact of the html output.
      - uses: actions/upload-artifact@v2
        with:
          name: DocumentationHTML
          path: docs/build/html/

  deploy_docs:
    if: ${{ github.ref == 'refs/heads/master' }}
    needs: build_docs
    runs-on: ${{ matrix.os }}
    strategy:
      fail-fast: false
      matrix:
        os: [ubuntu-latest]

    steps:
      - uses: actions/checkout@v3

      - name: Create local data folder
        run: |
          mkdir ~/mne_data

      - name: Cache datasets and docs
        id: cached-dataset-docs
        uses: actions/cache@v3
        with:
          key: doc-${{ github.head_ref }}-${{ hashFiles('moabb/datasets/**') }}
          path: |
            ~/mne_data
            docs/build

      - name: Checkout moabb.github.io
        uses: actions/checkout@v3
        with:
          repository: "NeuroTechX/moabb.github.io"
          path: moabb-ghio
          token: ${{ secrets.MOABB_GHIO }}

  deploy_gh_pages:
    if: ${{ github.ref == 'refs/heads/develop' }}
    needs: build_docs
    runs-on: ${{ matrix.os }}
    strategy:
      fail-fast: false
      matrix:
        os: [ubuntu-latest]

    steps:
      - uses: actions/checkout@v3

      - name: Create local data folder
        run: |
          mkdir ~/mne_data

      - name: Cache datasets and docs
        id: cached-dataset-docs
        uses: actions/cache@v3
        with:
          key: doc-${{ github.head_ref }}-${{ hashFiles('moabb/datasets/**') }}
          path: |
            ~/mne_data
            docs/build

      - name: Checkout gh pages
        uses: actions/checkout@v3
        with:
          ref: gh-pages
          path: moabb-ghpages

      - name: Deploy Neurotechx Subpage
        uses: peaceiris/actions-gh-pages@v3
        with:
          deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
          external_repository: NeuroTechX/moabb.github.io
          destination_dir: docs/
          publish_branch: master
          publish_dir: ./docs/build/html
          cname: moabb.neurotechx.com/

      - name: Deploy on gh-pages
        run: |
          git config --global user.email "ci@neurotechx.com"
          git config --global user.name "Github Actions"
          cd ~/work/moabb/moabb/moabb-ghpages
          rm -Rf docs
          cp -a ~/work/moabb/moabb/docs/build/html ./docs
          git add -A
          git commit -m "GH Actions update of GH pages ($GITHUB_RUN_ID - $GITHUB_RUN_NUMBER)"
          git push origin gh-pages