docs.yml

name: docs

on:
  push:
    branches:
      - master
  pull_request:

permissions:
  pages: write
  id-token: write

jobs:
  # Build job
  build:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v4
        with:
          lfs: true
      - name: Pull LFS objects
        run: git lfs pull
      - name: Set up Python
        uses: actions/setup-python@v2
      - name: Install package
        run: |
          python -m pip install --upgrade pip
          pip install setuptools wheel
          sudo apt-get install graphviz
          pip install -e .[doc]
      - name: Setup Pages
        id: pages
        uses: actions/configure-pages@v3
      - name: Build with Sphinx
        run: |
          cd ./docs
          make html
      - name: Upload artifact
        uses: actions/upload-pages-artifact@v3
        with:
          path: docs/_build/html/


  # Deployment job
  deploy:
    if: github.event_name == 'push'
    environment:
      name: github-pages
      url: ${{steps.deployment.outputs.page_url}}
    runs-on: ubuntu-latest
    needs: build
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4