New Documentation Structure

.gitignore

@@ -13,3 +13,4 @@ Testing/
 /*/*/jl_*/
 /Manifest.toml
 /test/Manifest.toml
+.vscode

docs/00-getting-started/00_getting-started.jmd

@@ -0,0 +1,78 @@
+---
+title: Getting Started
+permalink: /:collection/:name/
+redirect_from: docs/0-gettingstarted/
+weave_options:
+  error : false
+---
+
+# Getting Started
+
+## Installation
+
+To use Turing, you need to install Julia first and then install Turing.
+
+### Install Julia
+
+You will need to install Julia 1.3 or greater, which you can get from [the official Julia website](http://julialang.org/downloads/).
+
+### Install Turing.jl
+
+Turing is an officially registered Julia package, so you can install a stable version of Turing by running the following in the Julia REPL:
+
+```julia
+using Pkg
+Pkg.add("Turing")
+```
+
+You can check if all tests pass by running
+
+```julia
+Pkg.test("Turing")
+```
+
+## Example
+
+Here's a simple example showing Turing in action.
+
+First, we can load the Turing and StatsPlots modules
+
+```julia
+using Turing
+using StatsPlots
+```
+
+Then, we define a simple Normal model with unknown mean and variance
+
+```julia
+@model function gdemo(x, y)
+    s² ~ InverseGamma(2, 3)
+    m ~ Normal(0, sqrt(s²))
+    x ~ Normal(m, sqrt(s²))
+    return y ~ Normal(m, sqrt(s²))
+end
+```
+
+Then we can run sampler a sampler to collect results. In this case it is a Hamiltonian Monte Carlo sampler
+
+```julia
+chn = sample(gdemo(1.5, 2), HMC(0.1, 5), 1000)
+```
+
+We can use `describe` to summarise results
+
+```julia
+describe(chn)
+```
+
+Finally, we can plot the results
+
+```julia
+plot(chn)
+```
+
+The plots can also be saved
+
+```julia
+savefig("gdemo-plot.png")
+```

src/TuringTutorials.jl

@@ -20,6 +20,7 @@ function __init__()
 end
 
 function weave(
+    source_folder::AbstractString,
     folder::AbstractString,
     file::AbstractString;
     out_path_root::AbstractString=pwd(),
@@ -33,15 +34,15 @@ function weave(
         )
     end
 
-    target = joinpath(REPO_DIR, "tutorials", folder, file)
+    target = joinpath(REPO_DIR, source_folder, folder, file)
     @info("Weaving $(target)")
 
     # Activate project
     # TODO: use separate Julia process?
-    if isfile(joinpath(REPO_DIR, "tutorials", folder, "Project.toml")) &&
+    if isfile(joinpath(REPO_DIR, source_folder, folder, "Project.toml")) &&
         (:github in build || :html in build || :pdf in build)
         @info("Instantiating", folder)
-        Pkg.activate(joinpath(REPO_DIR, "tutorials", folder))
+        Pkg.activate(joinpath(REPO_DIR, source_folder, folder))
         Pkg.instantiate()
         Pkg.build()
 
@@ -91,23 +92,23 @@ function weave(
 end
 
 # Weave all tutorials
-function weave(; kwargs...)
-    for folder in readdir(joinpath(REPO_DIR, "tutorials"))
-        weave(folder; kwargs...)
+function weave(source_folder::AbstractString; kwargs...)
+    for folder in readdir(joinpath(REPO_DIR, source_folder))
+        weave(source_folder, folder; kwargs...)
     end
 end
 
 # Weave a folder of tutorials
-function weave(folder::AbstractString; kwargs...)
-    for file in readdir(joinpath(REPO_DIR, "tutorials", folder))
+function weave(source_folder::AbstractString, folder::AbstractString; kwargs...)
+    for file in readdir(joinpath(REPO_DIR, source_folder, folder))
         # Skip non-`.jmd` files
         endswith(file, ".jmd") || continue
 
-        weave(folder, file; kwargs...)
+        weave(source_folder, folder, file; kwargs...)
     end
 end
 
-function tutorial_footer(folder=nothing, file=nothing)
+function doc_footer(folder=nothing, file=nothing)
     display(
         Markdown.md"""
 ## Appendix
@@ -116,7 +117,7 @@ These tutorials are a part of the TuringTutorials repository, found at: <https:/
     )
     if folder !== nothing && file !== nothing
         display(Markdown.parse("""
-        To locally run this tutorial, do the following commands:
+        To locally run this doc, do the following commands:
         ```
         using TuringTutorials
         TuringTutorials.weave("$folder", "$file")