Skip to content

Commit

Permalink
Add check of docs and doctests
Browse files Browse the repository at this point in the history
  • Loading branch information
THinnerichs committed Apr 5, 2024
1 parent 1ada2a0 commit 55c763f
Showing 1 changed file with 37 additions and 0 deletions.
37 changes: 37 additions & 0 deletions .github/workflows/check_docs.yml
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
);
'

0 comments on commit 55c763f

Please sign in to comment.