Skip to content

Rewrite the docs (#389) #844

Rewrite the docs (#389)

Rewrite the docs (#389) #844

Workflow file for this run

name: Documenter
on:
push:
branches: [master]
tags: [v*]
pull_request:
defaults:
run:
shell: bash
concurrency:
group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
cancel-in-progress: true
jobs:
Documenter:
name: Documentation
runs-on: ubuntu-latest
env:
PYTHON: "" # for PyPlot
steps:
- uses: actions/checkout@v4
- uses: julia-actions/setup-julia@latest
with:
version: '1'
- run: julia --project -e 'using Pkg; Pkg.develop([PackageSpec(path=joinpath(pwd(), "SnoopCompileCore"))])'
- uses: julia-actions/julia-buildpkg@latest
# To access the developer tools from within a package's environment, they should be in the default environment
- run: julia -e 'using Pkg; Pkg.develop([PackageSpec(path=joinpath(pwd(), "SnoopCompileCore")), PackageSpec(path=joinpath(pwd()))]); Pkg.instantiate()'
# Additional packages we'll need
- run: julia -e 'using Pkg; Pkg.add(["AbstractTrees", "Cthulhu"])' # pyplot would be nice but it often errors
# Documenter wants them to be in the local environment
- run: julia --project=docs/ -e 'using Pkg; Pkg.develop([PackageSpec(path=joinpath(pwd(), "SnoopCompileCore")), PackageSpec(path=joinpath(pwd()))]); Pkg.instantiate()'
- uses: julia-actions/julia-docdeploy@releases/v1
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}