Use output_format = documenter_output (#35)

* Use `output_format = documenter_output`

* Apply JuliaFormatter

Author: rikhuijzer

docs/build.jl

@@ -4,36 +4,19 @@ tutorials_dir = joinpath(pkgdir(TuringGLM), "docs", "src", "tutorials")
 function build()
     println("Building tutorials")
     # Evaluate notebooks in the same process to avoid having to recompile from scratch each time.
+    # This is similar to how Documenter and Franklin evaluate code.
+    # Note that things like method overrides and other global changes may leak between notebooks!
     use_distributed = false
-    bopts = BuildOptions(tutorials_dir; use_distributed)
+    output_format = documenter_output
+    bopts = BuildOptions(tutorials_dir; use_distributed, output_format)
     parallel_build(bopts)
     return nothing
 end
 
-"Generate tutorials Markdown files which can be read by Documenter.jl"
-function generate_markdown_files()
+"Return Markdown file links which can be passed to Documenter.jl."
+function markdown_files()
     md_files = map(tutorials) do tutorial
         file = lowercase(replace(tutorial, " " => '_'))
-
-        from = joinpath(tutorials_dir, "$file.html")
-        html = read(from, String)
-
-        md = """
-            # $tutorial
-
-            ```@eval
-            # Auto generated file. Do not modify.
-            ```
-
-            ```@raw html
-            $html
-            ```
-            """
-
-        to = joinpath(tutorials_dir, "$file.md")
-        println("Writing $to")
-        write(to, md)
-
         return joinpath("tutorials", "$file.md")
     end
     return md_files

docs/make.jl

@@ -16,7 +16,8 @@ tutorials = [
 include("build.jl")
 
 build()
-md_files = generate_markdown_files()
+md_files = markdown_files()
+T = [t => f for (t, f) in zip(tutorials, md_files)]
 
 DocMeta.setdocmeta!(TuringGLM, :DocTestSetup, :(using TuringGLM); recursive=true)
 
@@ -32,7 +33,7 @@ makedocs(;
         mathengine=Documenter.MathJax3(),
         prettyurls=get(ENV, "CI", "false") == "true",
     ),
-    pages=["Home" => "index.md", "Tutorials" => md_files, "API reference" => "api.md"],
+    pages=["Home" => "index.md", "Tutorials" => T, "API reference" => "api.md"],
 )
 
 deploydocs(; repo="github.com/TuringLang/TuringGLM.jl", devbranch="main")