I get documenter to run when I push new stuff (aside from md files). My docs.yml looks like this.
The line I commented out responds to skip-ci. When I learned how skip CI and docs after a README.md edit, I didn’t need it any more.
This works best if you also use github actions do to CI.
Studying PkgTemplates.jl really helped me.
name: Documentation
on:
push:
branches:
- 'master'
- 'release-'
paths-ignore:
- 'LICENSE.md'
- 'README.md'
tags: '*'
pull_request:
jobs:
build:
runs-on: ${{ matrix.os }}
# if: "!contains(github.event.head_commit.message, 'skip ci')"
strategy:
matrix:
julia-version: [1.5]
julia-arch: [x86]
os: [ubuntu-latest]
steps:
- uses: actions/checkout@v2
- uses: julia-actions/setup-julia@latest
with:
version: ${{ matrix.julia-version }}
- name: Install dependencies
run: julia --project=docs/ -e 'using Pkg;
Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()'
- name: Build and deploy
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}
run: julia --project=docs --color=yes docs/make.jl