literate tutorials. found bug

Author: Alessandro

.gitignore

@@ -18,6 +18,7 @@ wip/
 # Build artifacts for creating documentation generated by the Documenter package
 docs/build/
 docs/site/
+docs/src/tutorials/*
 
 # File generated by Pkg, the package manager, based on a corresponding Project.toml
 # It records a fixed state of all packages used by the project. As such, it should not be

Project.toml

@@ -22,8 +22,9 @@ julia = "1.8"
 
 [extras]
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
+Literate = "98b081ad-f1c9-55d3-8b20-4c87d4299306"
 SafeTestsets = "1bc83da4-3b8d-516f-aca4-4fe02f6d838f"
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
 
 [targets]
-test = ["Test", "Documenter", "SafeTestsets"]
+test = ["Test", "Documenter", "SafeTestsets", "Literate"]

docs/Project.toml

@@ -1,5 +1,6 @@
 [deps]
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
+Literate = "98b081ad-f1c9-55d3-8b20-4c87d4299306"
 Metatheory = "e9d8d322-4543-424a-9be4-0cc815abe26c"
 
 [compat]

docs/make.jl

@@ -1,9 +1,26 @@
 using Documenter
 using Metatheory
+using Literate
 
 using Metatheory.EGraphs
 using Metatheory.Library
 
+TUTORIALSDIR = joinpath(dirname(pathof(Metatheory)), "../test/tutorials/")
+OUTDIR = abspath(joinpath(@__DIR__, "src", "tutorials"))
+
+for f in readdir(TUTORIALSDIR)
+  if endswith(f, ".jl")
+    input = abspath(joinpath(TUTORIALSDIR, f))
+    name = basename(input)
+    Literate.markdown(input, OUTDIR)
+  elseif f != "README.md"
+    @info "Copying $f"
+    cp(joinpath(TUTORIALSDIR, input), joinpath(OUTDIR, f); force=true)
+  end
+end
+
+tutorials = [joinpath("tutorials", f[1:end-3]) * ".md" for f in readdir(TUTORIALSDIR) if endswith(f, ".jl")]
+
 makedocs(
   modules = [Metatheory, Metatheory.EGraphs],
   sitename = "Metatheory.jl",
@@ -13,7 +30,8 @@ makedocs(
     "egraphs.md"
     "interface.md"
     "api.md"
+    "Tutorials" => tutorials
   ],
 )
 
-deploydocs(repo = "github.com/JuliaSymbolics/Metatheory.jl.git")
+#deploydocs(repo = "github.com/JuliaSymbolics/Metatheory.jl.git")

src/Rewriters.jl

@@ -115,11 +115,13 @@ instrument(x::Fixpoint, f) = Fixpoint(instrument(x.rw, f))
 
 function (rw::Fixpoint)(x)
   f = rw.rw
+  @show "fixpoint" x
   y = @timer cached_repr(f) f(x)
   while x !== y && !isequal(x, y)
     y === nothing && return x
     x = y
     y = @timer cached_repr(f) f(x)
+    @show y
   end
   return x
 end

test/integration/while_interpreter.jl

@@ -0,0 +1,4 @@
+# Literate tests
+
+This folder contains Julia scripts in the [Literate.jl](https://fredrikekre.github.io/Literate.jl/v2/) format.
+Such scripts are executed by tests, and are also included in the generated documentation.

test/tutorials/README.md

@@ -0,0 +1,13 @@
+#=
+
+# Test
+
+markdown foo ~bar~
+
+=#
+
+println("foo")
+
+# ok
+
+2