juliagaussianprocesses / juliagpsdocs.jl Goto Github PK

to check JuliaGPsDocs's error handling.
e.g.:

• missing Project.toml
• badly-set up Project.toml
• missing script.jl
• script.jl that fails
• would an existing Manifest.toml get in the way?

Right now new processese are started in parallel without a limit. This can easily lead to OOM on the Github runners, we should be able to add a limiter on the number of processes running at the same time.
@devmotion I think you originally wrote this script, would you have a suggestion?

• option 1: check that the project env contains Literate.jl, otherwise explicit error
• option 2: automagically add Literate to the environment

Since the output folder is fixed (for now) we could provide helper function to access the produced examples. Something like:

map(filter!(isdir, readdir("src/examples"))) do x
    joinpath("examples", x, "example.md")
end

Instead of creating and destructing Julia sessions every time we could keep them open and just rerun the script without recompiling everything.
This could be achieved with https://github.com/c42f/RemoteREPL.jl

@theogf given that JuliaGPsDocs is an opinionated package for making it easier to get consistent docs setup across our packages, how about we let it also provide this as a function so we can just do

        "Examples" => JuliaGPsDocs.find_notebook_examples(),

? :)

Originally posted by @st-- in JuliaGaussianProcesses/KernelFunctions.jl#443 (comment)