doc.yml

# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions

name: Docs

on:
  workflow_dispatch:
  push:
    branches: [master]
  pull_request:
    branches: [master]

defaults:
  run:
    shell: bash

jobs:
  build:
    runs-on: ubuntu-latest
    defaults:
      run:
        shell: bash
    strategy:
      fail-fast: false
      matrix:
        python-version: [3.12]
    env:
      FURY_OFFSCREEN: 1
      FURY_RECORD_ANIMATION: 1
      QT_QPA_PLATFORM: xcb
    steps:
    - uses: actions/checkout@v7
      with:
        fetch-depth: 0
    - name: Set up Python ${{ matrix.python-version }}
      uses: actions/setup-python@v6
      with:
        python-version: ${{ matrix.python-version }}
    - name: Setup Headless
      run: ci/setup_headless.sh
    - name: Install Dependencies
      run: |
        python -c "import sys; print(sys.version)"
        python -m pip install -U pip setuptools>=30.3.0 wheel
        python -m pip install -U -r requirements/default.txt
        python -m pip install -U -r requirements/optional.txt
        python -m pip install -U -r requirements/doc.txt
    - name: Install FURY
      run: pip install .
    - name: Build docs
      run: |
        cd docs
        make -C . html SPHINXOPTS="-W --keep-going"
    - name: Deploy Devs
      if: success() && github.ref == 'refs/heads/master' && github.repository == 'fury-gl/fury'
      uses: JamesIves/github-pages-deploy-action@v4
      with:
        ssh-key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
        repository-name: fury-gl/fury-website
        folder: ./docs/build/html
        target-folder: dev