Skip to content

Commit 52248be

Browse files
committed
Add extension docs pages
1 parent e70512b commit 52248be

File tree

3 files changed

+40
-1
lines changed

3 files changed

+40
-1
lines changed

docs/make.jl

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
11
using InferenceObjects
22
using Documenter
33
using DocumenterInterLinks
4+
using MCMCDiagnosticTools: MCMCDiagnosticTools # load extension
45
using NCDatasets: NCDatasets # load extension
6+
using PosteriorStats: PosteriorStats # load extension
7+
using StatsBase: StatsBase # load extension
58

69
DocMeta.setdocmeta!(
710
InferenceObjects, :DocTestSetup, :(using InferenceObjects); recursive=true
@@ -18,7 +21,11 @@ doctestfilters = [
1821
]
1922

2023
makedocs(;
21-
modules=[InferenceObjects],
24+
modules=[
25+
InferenceObjects,
26+
Base.get_extension(InferenceObjects, :InferenceObjectsMCMCDiagnosticToolsExt),
27+
Base.get_extension(InferenceObjects, :InferenceObjectsPosteriorStatsExt),
28+
],
2229
authors="Seth Axen <[email protected]> and contributors",
2330
repo=Remotes.GitHub("arviz-devs", "InferenceObjects.jl"),
2431
sitename="InferenceObjects.jl",
@@ -32,6 +39,10 @@ makedocs(;
3239
"Home" => "index.md",
3340
"Dataset" => "dataset.md",
3441
"InferenceData" => "inference_data.md",
42+
"Extensions" => [
43+
"MCMCDiagnosticTools" => "extensions/mcmcdiagnostictools.md",
44+
"PosteriorStats" => "extensions/posteriorstats.md",
45+
],
3546
],
3647
doctestfilters=doctestfilters,
3748
warnonly=:missing_docs,
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Extension of MCMCDiagnosticTools
2+
3+
The following methods of [MCMCDiagnosticTools.jl](https://julia.arviz.org/MCMCDiagnosticTools) are extended by this package.
4+
5+
```@index
6+
Modules = [MCMCDiagnosticTools]
7+
```
8+
9+
```@autodocs
10+
Modules = [Base.get_extension(InferenceObjects, :InferenceObjectsMCMCDiagnosticToolsExt)]
11+
Private = false
12+
```
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Extension of PosteriorStats
2+
3+
The following methods of [PosteriorStats.jl](https://julia.arviz.org/PosteriorStats) are extended by this package.
4+
5+
```@index
6+
Modules = [
7+
Base.get_extension(InferenceObjects, :InferenceObjectsPosteriorStatsExt),
8+
PosteriorStats,
9+
StatsBase,
10+
]
11+
```
12+
13+
```@autodocs
14+
Modules = [Base.get_extension(InferenceObjects, :InferenceObjectsPosteriorStatsExt)]
15+
Private = false
16+
```

0 commit comments

Comments
 (0)