diff --git a/docs/make.jl b/docs/make.jl index b53cf71f..0396998a 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -14,9 +14,9 @@ makedocs( "StreamSampling.jl" => "index.md", "Basics" => "basics.md", "An Illustrative Example" => "example.md", - "API" => "api.md", "Performance Tips" => "perf_tips.md", - "Benchmarks" => "benchmark.md" + "Benchmarks" => "benchmark.md", + "API" => "api.md", ], warnonly = [:doctest, :missing_docs, :cross_references], ) @@ -31,4 +31,4 @@ if CI devbranch = "main", ) end -println("Finished building and deploying docs.") \ No newline at end of file +println("Finished building and deploying docs.") diff --git a/docs/src/index.md b/docs/src/index.md index 7b9e9f52..df99010d 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -1,10 +1,17 @@ -# StreamSampling.jl +# Introduction ```@docs StreamSampling ``` +## Installation + +```julia +using Pkg +Pkg.add("StreamSampling") +``` + ## Reproducibility ```@raw html diff --git a/docs/src/perf_tips.md b/docs/src/perf_tips.md index 7fe632cf..e7355c22 100644 --- a/docs/src/perf_tips.md +++ b/docs/src/perf_tips.md @@ -26,11 +26,11 @@ iter = 1:10^7; Running with both version we get ```@example 1 -@btime fit_iter!(rs, $iter) setup=(rs = ReservoirSampler{Int}(10, AlgRSWRSKIP(); mutable = true)) +@btime fit_iter!(rs, $iter) setup=(rs = ReservoirSampler{Int}(10, AlgRSWRSKIP(); mutable = true)); ``` ```@example 1 -@btime fit_iter!(rs, $iter) setup=(rs = ReservoirSampler{Int}(10, AlgRSWRSKIP(); mutable = false)) +@btime fit_iter!(rs, $iter) setup=(rs = ReservoirSampler{Int}(10, AlgRSWRSKIP(); mutable = false)); ``` As you can see, the immutable version is 50% faster than