Documenter.yml

name: Documenter
on:
  push:
    branches: [main, master]
    tags: [v*]
  pull_request:

permissions:
  actions: write   # needed to allow julia-actions/cache to delete old caches that it has created
  contents: write  # needed to allow deploying docs
  statuses: write

jobs:
  Documenter:
    name: Documentation
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: julia-actions/setup-julia@v2
        with:
          version: '1'                         # replace this with whatever version you need
          show-versioninfo: true               # this causes versioninfo to be printed to the action log
      - uses: julia-actions/cache@v2           # cache using https://github.com/julia-actions/cache
      - uses: julia-actions/julia-buildpkg@v1  # if package requires Pkg.build()
      - uses: julia-actions/julia-docdeploy@v1
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}