Skip to content

Commit e64ec8c

Browse files
authored
Add MCMCChainsExt to docs build (#822)
1 parent 7a14915 commit e64ec8c

File tree

2 files changed

+6
-6
lines changed

2 files changed

+6
-6
lines changed

docs/make.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ makedocs(;
2222
# The API index.html page is fairly large, and violates the default HTML page size
2323
# threshold of 200KiB, so we double that.
2424
format=Documenter.HTML(; size_threshold=2^10 * 400),
25-
modules=[DynamicPPL],
25+
modules=[DynamicPPL, Base.get_extension(DynamicPPL, :DynamicPPLMCMCChainsExt)],
2626
pages=[
2727
"Home" => "index.md", "API" => "api.md", "Internals" => ["internals/varinfo.md"]
2828
],

docs/src/api.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -108,14 +108,14 @@ unfix
108108

109109
DynamicPPL provides functionality for generating samples from the posterior predictive distribution through the `predict` function. This allows you to use posterior parameter samples to generate predictions for unobserved data points.
110110

111-
```@docs
112-
predict
113-
```
114-
115111
The `predict` function has two main methods:
116112

117113
1. For `AbstractVector{<:AbstractVarInfo}` - useful when you have a collection of `VarInfo` objects representing posterior samples.
118-
2. For `MCMCChains.Chains` - useful when you have posterior samples in the form of a `Chains` object from MCMCChains.jl.
114+
2. For `MCMCChains.Chains` (only available when `MCMCChains.jl` is loaded) - useful when you have posterior samples in the form of an `MCMCChains.Chains` object.
115+
116+
```@docs
117+
predict
118+
```
119119

120120
### Basic Usage
121121

0 commit comments

Comments
 (0)