diff --git a/docs/make.jl b/docs/make.jl index 0e1094e..bf2281e 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -42,9 +42,11 @@ makedocs(; ), pages=[ "Home" => "index.md", - "Gedtting Started" => "getting_started.md", + "Getting Started" => "getting_started.md", "Performance Checking" => [ "PerfChecker.jl" => "perf_checker.md", + "BenchmarkToolsExt" => "benchmark_ext.md", + "Interface" => "perf_interface.md", ], "Constraints" => [ "ConstraintCommons.jl" => "constraint_commons.md", diff --git a/docs/src/benchmark_ext.md b/docs/src/benchmark_ext.md new file mode 100644 index 0000000..bc7dbb8 --- /dev/null +++ b/docs/src/benchmark_ext.md @@ -0,0 +1,3 @@ +# BenchmarkTools Extension + +A benchmarking extension, based on `BenchmarkTools.jl`, has been interfaced with `PerfChecker.jl`. This section (will) provides some usage examples, documentation, and links to related notebooks. diff --git a/docs/src/perf_interface.md b/docs/src/perf_interface.md new file mode 100644 index 0000000..986949c --- /dev/null +++ b/docs/src/perf_interface.md @@ -0,0 +1,3 @@ +# Interfacing PerfChecker + +PerfChecker was build as an easy to extend interface. This section will cover the few method required.