build_doc.yml

name: Build documentation

on: [push, pull_request]

permissions: write-all

env:
  OCAML_DEFAULT_VERSION: 4.14.2
  # Add OPAMYES=true to the environment, this is usefill to replace `-y` option
  # in any opam call
  OPAMYES: true

jobs:
  build:
    runs-on: ubuntu-latest
    env:
      OPAMWITHDOC: true

    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - name: Use OCaml ${{ env.OCAML_DEFAULT_VERSION }}
        uses: ocaml/setup-ocaml@v3
        with:
          ocaml-compiler: ${{ env.OCAML_DEFAULT_VERSION }}
          dune-cache: true

      - name: Setup python
        uses: actions/setup-python@v5
        with:
          python-version: '3.10'

      - name: Install dependencies
        run: opam exec -- make doc-deps

      - name: Build documentation
        run: opam exec -- make doc

      - name: Upload artifact
        uses: actions/upload-artifact@v4
        with:
          name: artifact-doc
          path: _build/doc

  deploy:
    needs: build
    runs-on: ubuntu-latest

    steps:
      - name: Download artifact
        uses: actions/download-artifact@v4
        with:
          name: artifact-doc
          path: build_doc

      - name: Deploy
        uses: peaceiris/actions-gh-pages@v4
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_dir: build_doc
          destination_dir: dev
          enable_jekyll: true