Documenter.yml

name: Documentation

on:
  push:
    branches:
      - main
  pull_request:

jobs:
  build:
    name: Documentation
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - name: Install packages for generating tikz images
        run: |
          sudo apt-get install imagemagick
          sudo apt-get install poppler-utils
          sudo apt-get install texlive-xetex
          sudo apt-get install texlive-science
      - name: Make tikz images
        run: make all -C docs/src/tikz
      # NOTE: Python is necessary for the pre-rendering (minification) step; I copied this bit, do not know if that's actually needed
      - name: Install python
        uses: actions/setup-python@v5
        with:
          python-version: '3.8'
      - name: Install binary dependencies
        run: sudo apt-get update && sudo apt-get install -y xorg-dev mesa-utils xvfb libgl1 freeglut3-dev libxrandr-dev libxinerama-dev libxcursor-dev libxi-dev libxext-dev
      - uses: julia-actions/setup-julia@latest
        with:
          version: '1'
      - name: Install BrenierTwoFluid package
        run: |
          cd docs
          DISPLAY=:0 xvfb-run -s '-screen 0 1024x768x24' make install_brenier_two_fluid test_docs
          cd .. 
      - name: Make docs (call julia documenter)
        run: DISPLAY=:0 xvfb-run -s '-screen 0 1024x768x24' julia --project=docs docs/make.jl html_output
      - uses: julia-actions/julia-buildpkg@v1
      - uses: julia-actions/julia-docdeploy@v1
        with:
          prefix: xvfb-run
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}