website.yml

# Builds static content for GitHub pages.

name: Build website

on:
  push:
    branches:
      # 'main' triggers updates to 'sleap.ai', all others to 'sleap.ai/develop'
      - main
      - develop
      - liezl/update-intallation-docs-1.4.1
    paths:
      - "docs/**"
      - "README.rst"
      - ".github/workflows/website.yml"

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      # Setup
      - name: Checkout
        uses: actions/checkout@v4

      - name: Setup Miniconda
        # https://github.com/conda-incubator/setup-miniconda
        uses: conda-incubator/setup-miniconda@v3.0.3
        with:
          python-version: 3.7
          environment-file: environment_no_cuda.yml
          activate-environment: sleap_ci
      - name: Print environment info
        shell: bash -l {0}
        run: |
          which python
          conda info

      - name: Build
        # """Could not import extension myst_nb (exception: lxml.html.clean module is now 
        # a separate project lxml_html_clean. Install lxml[html_clean] or 
        # lxml_html_clean directly.)"""
        shell: bash -l {0}
        run: |
          pip install lxml[html_clean]
          pip install sphinx-tabs
          cd docs
          python make_api_doctree.py
          make html

      - name: Deploy (sleap.ai)
        uses: peaceiris/actions-gh-pages@v4
        if: github.ref == 'refs/heads/main'
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_branch: gh-pages
          publish_dir: docs/build/html
          keep_files: true

      - name: Deploy (test)
        uses: peaceiris/actions-gh-pages@v4
        if: github.ref != 'refs/heads/main'
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_branch: gh-pages
          publish_dir: docs/build/html
          destination_dir: develop