-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
1ada2a0
commit 55c763f
Showing
1 changed file
with
37 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
name: Check Docs | ||
|
||
on: | ||
push: | ||
branches: | ||
- add_linting # update to match your development branch (master, main, dev, trunk, ...) | ||
tags: '*' | ||
pull_request: | ||
|
||
jobs: | ||
documentation: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v2 | ||
- name: Set up Julia | ||
uses: julia-actions/setup-julia@v1 | ||
with: | ||
version: '1' # Use the latest stable Julia version | ||
- name: Install dependencies | ||
run: | | ||
julia --project=docs -e ' | ||
using Pkg; | ||
Pkg.develop(PackageSpec(path=pwd())); | ||
Pkg.instantiate(); | ||
Pkg.add("Documenter"); | ||
' | ||
- name: Try building documentation and run doctests | ||
run: | | ||
julia --project=docs -e ' | ||
using Documenter, HerbCore; | ||
makedocs( | ||
modules=[HerbCore] | ||
format=Documenter.HTML(), | ||
doctest=true, | ||
warnonly=:doctest | ||
); | ||
' |