Do not install packages in parallel (#108)

bors r+

Author: devmotion

docs/literate.jl

@@ -1,13 +1,15 @@
-# Retrieve filename of literate script
+# Retrieve name of example and output directory
 if length(ARGS) != 2
-    error("please specify the literate script and the output directory")
+    error("please specify the name of the example and the output directory")
 end
-const SCRIPTJL = ARGS[1]
+const EXAMPLE = ARGS[1]
 const OUTDIR = ARGS[2]
 
 # Activate environment
+# Note that each example's Project.toml must include Literate as a dependency
 using Pkg: Pkg
-Pkg.activate(dirname(SCRIPTJL))
+const EXAMPLEPATH = joinpath(@__DIR__, "..", "examples", EXAMPLE)
+Pkg.activate(EXAMPLEPATH)
 Pkg.instantiate()
 using Literate: Literate
 
@@ -38,19 +40,10 @@ function preprocess(content)
 end
 
 # Convert to markdown and notebook
+const SCRIPTJL = joinpath(EXAMPLEPATH, "script.jl")
 Literate.markdown(
-    SCRIPTJL,
-    OUTDIR;
-    name=basename(dirname(SCRIPTJL)),
-    documenter=false,
-    execute=true,
-    preprocess=preprocess,
+    SCRIPTJL, OUTDIR; name=EXAMPLE, documenter=false, execute=true, preprocess=preprocess
 )
 Literate.notebook(
-    SCRIPTJL,
-    OUTDIR;
-    name=basename(dirname(SCRIPTJL)),
-    documenter=false,
-    execute=true,
-    preprocess=preprocess,
+    SCRIPTJL, OUTDIR; name=EXAMPLE, documenter=false, execute=true, preprocess=preprocess
 )

docs/make.jl

@@ -1,22 +1,36 @@
+### Process examples
 # Always rerun examples
 const EXAMPLES_OUT = joinpath(@__DIR__, "src", "examples")
 ispath(EXAMPLES_OUT) && rm(EXAMPLES_OUT; recursive=true)
 mkpath(EXAMPLES_OUT)
 
+# Install and precompile all packages
+# Workaround for https://github.com/JuliaLang/Pkg.jl/issues/2219
+examples = filter!(isdir, readdir(joinpath(@__DIR__, "..", "examples"); join=true))
+let script = "using Pkg; Pkg.activate(ARGS[1]); Pkg.instantiate()"
+    for example in examples
+        if !success(`$(Base.julia_cmd()) -e $script $example`)
+            error(
+                "project environment of example ",
+                basename(example),
+                " could not be instantiated",
+            )
+        end
+    end
+end
 # Run examples asynchronously
-const EXAMPLES_SRC = joinpath(@__DIR__, "..", "examples")
-const LITERATEJL = joinpath(@__DIR__, "literate.jl")
-processes = map(filter!(isdir, readdir(EXAMPLES_SRC; join=true))) do example
-    scriptjl = joinpath(example, "script.jl")
-    return run(
-        pipeline(
-            `$(Base.julia_cmd()) $LITERATEJL $scriptjl $EXAMPLES_OUT`;
-            stdin=devnull,
-            stdout=devnull,
-            stderr=stderr,
-        );
-        wait=false,
-    )::Base.Process
+processes = let literatejl = joinpath(@__DIR__, "literate.jl")
+    map(examples) do example
+        return run(
+            pipeline(
+                `$(Base.julia_cmd()) $literatejl $(basename(example)) $EXAMPLES_OUT`;
+                stdin=devnull,
+                stdout=devnull,
+                stderr=stderr,
+            );
+            wait=false,
+        )::Base.Process
+    end
 end
 
 # Check that all examples were run successfully