Try PlutoStaticHTML for documenter integration (#25)

Author: vchuravy

docs/Project.toml

@@ -9,6 +9,7 @@ LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
 Literate = "98b081ad-f1c9-55d3-8b20-4c87d4299306"
 NewtonKrylov = "0be81120-40bf-4f8b-adf0-26103efb66f1"
 OffsetArrays = "6fe1bfb0-de20-5000-8ca7-80f57d26f881"
+PlutoStaticHTML = "359b1769-a58e-495b-9770-312e911026ad"
 SparseArrays = "2f01184e-e22b-5df5-ae63-d93ebab69eaf"
 SummationByPartsOperators = "9f78cca6-572e-554e-b819-917d2f1cf240"
 

docs/make.jl

@@ -4,8 +4,31 @@ using NewtonKrylov
 using Documenter
 import Documenter.Remotes: GitHub
 using Literate
+using PlutoStaticHTML
 using DocumenterCitations
 
+const NOTEBOOK_DIR = joinpath(@__DIR__, "src", "notebooks")
+
+"""
+    build()
+
+Run all Pluto notebooks (".jl" files) in `NOTEBOOK_DIR`.
+"""
+function build()
+    println("Building notebooks in $NOTEBOOK_DIR")
+    oopts = OutputOptions(; append_build_context = false)
+    output_format = documenter_output
+    bopts = BuildOptions(NOTEBOOK_DIR; output_format)
+    build_notebooks(bopts, oopts)
+    return nothing
+end
+
+# Build the notebooks; defaults to true.
+if get(ENV, "BUILD_DOCS_NOTEBOOKS", "true") == "true"
+    build()
+end
+
+
 DocMeta.setdocmeta!(NewtonKrylov, :DocTestSetup, :(using NewtonKrylov); recursive = true)
 
 
@@ -54,10 +77,15 @@ makedocs(;
             "assets/citations.css",
         ],
         mathengine = MathJax3(),
+        size_threshold = 10_000_000,
     ),
     pages = [
         "Home" => "index.md",
         "Examples" => examples,
+        "Notebooks" => [
+            "Heat 2D" => "notebooks/heat_2d.md",
+            "Heat 1D DG" => "notebooks/heat_1D_DG.md",
+        ],
     ],
     doctest = true,
     linkcheck = true,

notebooks/Project.toml renamed to docs/src/notebooks/Project.toml

@@ -7,3 +7,6 @@ Pluto = "c3e4b0f8-55cb-11ea-2926-15256bba5781"
 PlutoLinks = "0ff47ea0-7a50-410d-8455-4348d5de0420"
 PlutoUI = "7f904dfe-b85e-4ff6-b463-dae2292396a8"
 SummationByPartsOperators = "9f78cca6-572e-554e-b819-917d2f1cf240"
+
+[sources]
+NewtonKrylov = {path = "../../.."}

notebooks/heat_1D_DG.jl renamed to docs/src/notebooks/heat_1D_DG.jl

@@ -22,6 +22,7 @@ begin
     # careful: this is _not_ a reproducible environment
     # activate the local environment
     Pkg.activate(".")
+    Pkg.instantiate()
     using PlutoUI, PlutoLinks
     using CairoMakie
 end
@@ -36,7 +37,7 @@ using SummationByPartsOperators
 using LinearAlgebra
 
 # ╔═╡ 5bffc041-0019-4f1f-9711-170b82f62926
-Implicit = @ingredients(joinpath(@__DIR__, "../examples/implicit.jl"));
+Implicit = @ingredients(joinpath(dirname(pathof(NewtonKrylov)), "../examples/implicit.jl"));
 
 # ╔═╡ 493850fa-87db-452d-961a-26f92c88d18f
 md"""

notebooks/heat_2d.jl renamed to docs/src/notebooks/heat_2d.jl

@@ -22,6 +22,7 @@ begin
     # careful: this is _not_ a reproducible environment
     # activate the local environment
     Pkg.activate(".")
+    Pkg.instantiate()
     using PlutoUI, PlutoLinks
     using CairoMakie
 end
@@ -84,13 +85,13 @@ function diffusion!(du, u, (a, Δx, Δy, bc!), _)
 end
 
 # ╔═╡ 91d3c59d-a144-4dd2-9e1f-d532c010f442
-HaloVectors = @ingredients(joinpath(@__DIR__, "../examples/halovector.jl"));
+HaloVectors = @ingredients(joinpath(dirname(pathof(NewtonKrylov)), "../examples/halovector.jl"))
 
 # ╔═╡ 2031ff0e-3b8a-4b21-a49f-e661d810994f
 import .HaloVectors: HaloVector
 
 # ╔═╡ 8aebcc1b-ac2b-40a5-9ca2-cbf3e24fdbb8
-Implicit = @ingredients(joinpath(@__DIR__, "../examples/implicit.jl"));
+Implicit = @ingredients(joinpath(dirname(pathof(NewtonKrylov)), "../examples/implicit.jl"));
 
 # ╔═╡ 56354eaa-a634-45e1-9001-84c1d69f845f
 import .Implicit: jacobian, solve, G_Euler!