doc.yml

name: Build documentation

on: [push, pull_request]

jobs:
  docs:

    runs-on: ubuntu-latest
    env:
      PYVISTA_OFF_SCREEN: 'True'
      ALLOW_PLOTTING: true
      SHELLOPTS: 'errexit:pipefail'

    steps:
      - uses: nschloe/action-cached-lfs-checkout@v1
      - uses: actions/setup-python@v4
        with:
            python-version: '3.9'
      - name: Install fteikpy
        run: |
          pip install -e .[full]
      - name: Install dependencies
        run: |
          pip install -r doc/requirements.txt
      - name: Sphinx build
        run: |
          sphinx-build -b html doc/source doc/build
      - name: Deploy
        uses: peaceiris/actions-gh-pages@v3
        if: ${{ github.event_name == 'push' }}
        with:
          publish_branch: gh-pages
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_dir: doc/build/
          force_orphan: true