check_docs.yml

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;
          content = """
            ```@meta
            CurrentModule = HerbCore
            DocTestSetup = quote
                using HerbCore
            end
            ```

            ```@autodocs
            Modules = [HerbCore]
            ```
          """
          mkpath("src/")
          open("src/index.md", "w") do file
            write(file, content)
          end
          makedocs(
            sitename="HerbCore.jl",
            modules=[HerbCore],
            format=Documenter.HTML(),
            doctest=true,
            warnonly=[:missing_docs],
            pages=["index.md"]
          );
        '