From 5380178b6fdebbcad98ddcf27dd2e998bbc306df Mon Sep 17 00:00:00 2001 From: Abhinav Natarajan Date: Tue, 6 Dec 2022 12:09:09 +0000 Subject: [PATCH] differentiate local example build --- docs/make.jl | 6 +++--- docs/src/{reference.md => API.md} | 2 +- examples/basic_example.jl | 6 ++++++ 3 files changed, 10 insertions(+), 4 deletions(-) rename docs/src/{reference.md => API.md} (97%) diff --git a/docs/make.jl b/docs/make.jl index 8ee9ab1..febf916 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -65,9 +65,9 @@ makedocs(; pages = [ "Introduction" => "index.md", "Example" => joinpath(genfolder, "example.md"), - "Funding" => "funding.md", - "Citation Information" => "cite.md", - "API" => "reference.md", + "Funding Information" => "funding.md", + "Cite This Package" => "cite.md", + "Public API" => "reference.md", "Changelog" => "changelog.md" ] ) diff --git a/docs/src/reference.md b/docs/src/API.md similarity index 97% rename from docs/src/reference.md rename to docs/src/API.md index 7f899f0..8908eab 100644 --- a/docs/src/reference.md +++ b/docs/src/API.md @@ -1,4 +1,4 @@ -# Reference +# Public API ## Main functions ```@autodocs diff --git a/examples/basic_example.jl b/examples/basic_example.jl index f11450c..7b28e1f 100644 --- a/examples/basic_example.jl +++ b/examples/basic_example.jl @@ -158,7 +158,13 @@ begin end #md # ## Sampling # Running the MCMC is straightforward. We set up the MCMC options using [`MCMCOptionsList`](@ref). +#local! +options = MCMCOptionsList(numiters=5000) +#!local +#CI! options = MCMCOptionsList(numiters=50000) +#!CI + # We then set up the input data using [`MCMCData`](@ref). data = MCMCData(points) # We can then run the sampler using [`runsampler`](@ref).