-
Notifications
You must be signed in to change notification settings - Fork 40
Expand file tree
/
Copy pathmake.jl
More file actions
48 lines (40 loc) · 1.47 KB
/
make.jl
File metadata and controls
48 lines (40 loc) · 1.47 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
### Process examples
using Pkg
Pkg.add(Pkg.PackageSpec(; url="https://github.com/JuliaGaussianProcesses/JuliaGPsDocs.jl")) # While the package is unregistered, it's a workaround
using JuliaGPsDocs
using KernelFunctions
using PDMats, Kronecker # we have to load all optional packages to generate the full API documentation
JuliaGPsDocs.generate_examples(KernelFunctions)
### Build documentation
using Documenter
# Doctest setup
DocMeta.setdocmeta!(
KernelFunctions,
:DocTestSetup,
quote
using KernelFunctions
end; # we have to load all packages used (implicitly) within jldoctest blocks in the API docstrings
recursive=true,
)
const KroneckerExt = Base.get_extension(KernelFunctions, :KernelFunctionsKroneckerExt)
const PDMatsExt = Base.get_extension(KernelFunctions, :KernelFunctionsPDMatsExt)
makedocs(;
sitename="KernelFunctions.jl",
format=Documenter.HTML(; size_threshold=10^6, size_threshold_warn=10^6),
modules=[KernelFunctions, KroneckerExt, PDMatsExt],
pages=[
"Home" => "index.md",
"userguide.md",
"kernels.md",
"transform.md",
"metrics.md",
"create_kernel.md",
"API" => "api.md",
"Design" => "design.md",
"Examples" => JuliaGPsDocs.find_generated_examples(KernelFunctions),
],
checkdocs=:exports,
doctestfilters=JuliaGPsDocs.DOCTEST_FILTERS,
)
# Remove JuliaGPsDocs (when running locally, we don't want to accidentally commit it)
Pkg.rm("JuliaGPsDocs")