Skip to content

Merge pull request #69 from cesmix-mit/new-examples #190

Merge pull request #69 from cesmix-mit/new-examples

Merge pull request #69 from cesmix-mit/new-examples #190

Workflow file for this run

name: Documentation
on:
pull_request:
push:
branches:
- main
tags: "*"
jobs:
docs:
name: Documentation
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: julia-actions/setup-julia@v1
with:
version: "1.10"
- name: add CESMIX registry
run: |
julia -e '
using Pkg
Pkg.Registry.add("General")
Pkg.Registry.add(RegistrySpec(url = "https://github.com/cesmix-mit/CESMIX.git"))
Pkg.Registry.add(RegistrySpec(url = "https://github.com/JuliaMolSim/MolSim.git"))
Pkg.Registry.add(RegistrySpec(url = "https://github.com/ACEsuit/ACEregistry"))
'
shell: bash
- name: instantiate docs
run: |
julia --project=docs -e '
using Pkg
Pkg.develop(PackageSpec(path=pwd()))
Pkg.instantiate()
'
- name: run doctests
run: |
julia --project=docs -e '
using Documenter: DocMeta, doctest
using PotentialLearning
DocMeta.setdocmeta!(PotentialLearning, :DocTestSetup, :(using PotentialLearning); recursive=true)
doctest(PotentialLearning)
'
- name: generate docs
run: julia --project=docs docs/make.jl
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}