Skip to content

Commit 9707459

Browse files
committed
Build docs with larger terminal width
1 parent 5a470f2 commit 9707459

File tree

2 files changed

+41
-39
lines changed

2 files changed

+41
-39
lines changed

docs/make.jl

Lines changed: 30 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -29,34 +29,37 @@ doctestfilters = [
2929
r"\s+\"created_at\" => .*", # ignore timestamps in doctests
3030
]
3131

32-
makedocs(;
33-
modules=[
34-
InferenceObjects,
35-
Base.get_extension(InferenceObjects, :InferenceObjectsMCMCDiagnosticToolsExt),
36-
Base.get_extension(InferenceObjects, :InferenceObjectsPosteriorStatsExt),
37-
],
38-
authors="Seth Axen <[email protected]> and contributors",
39-
repo=Remotes.GitHub("arviz-devs", "InferenceObjects.jl"),
40-
sitename="InferenceObjects.jl",
41-
format=Documenter.HTML(;
42-
prettyurls=get(ENV, "CI", "false") == "true",
43-
canonical="https://arviz-devs.github.io/InferenceObjects.jl",
44-
edit_link="main",
45-
assets=String[],
46-
),
47-
pages=[
48-
"Home" => "index.md",
49-
"Dataset" => "dataset.md",
50-
"InferenceData" => "inference_data.md",
51-
"Extensions" => [
52-
"MCMCDiagnosticTools" => "extensions/mcmcdiagnostictools.md",
53-
"PosteriorStats" => "extensions/posteriorstats.md",
32+
# Increase the terminal width from 80 to 100 chars to avoid column truncation
33+
withenv("COLUMNS" => 100) do
34+
makedocs(;
35+
modules=[
36+
InferenceObjects,
37+
Base.get_extension(InferenceObjects, :InferenceObjectsMCMCDiagnosticToolsExt),
38+
Base.get_extension(InferenceObjects, :InferenceObjectsPosteriorStatsExt),
5439
],
55-
],
56-
doctestfilters=doctestfilters,
57-
warnonly=:missing_docs,
58-
plugins=[links],
59-
)
40+
authors="Seth Axen <[email protected]> and contributors",
41+
repo=Remotes.GitHub("arviz-devs", "InferenceObjects.jl"),
42+
sitename="InferenceObjects.jl",
43+
format=Documenter.HTML(;
44+
prettyurls=get(ENV, "CI", "false") == "true",
45+
canonical="https://arviz-devs.github.io/InferenceObjects.jl",
46+
edit_link="main",
47+
assets=String[],
48+
),
49+
pages=[
50+
"Home" => "index.md",
51+
"Dataset" => "dataset.md",
52+
"InferenceData" => "inference_data.md",
53+
"Extensions" => [
54+
"MCMCDiagnosticTools" => "extensions/mcmcdiagnostictools.md",
55+
"PosteriorStats" => "extensions/posteriorstats.md",
56+
],
57+
],
58+
doctestfilters=doctestfilters,
59+
warnonly=:missing_docs,
60+
plugins=[links],
61+
)
62+
end
6063

6164
# run doctests on extensions
6265
function get_extension(mod::Module, name::Symbol)

ext/InferenceObjectsPosteriorStatsExt/summarize.jl

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -33,18 +33,17 @@ julia> data = load_example_data("centered_eight");
3333
3434
julia> summarize(data)
3535
SummaryStats
36-
mean std eti94 ess_tail ess_bulk rhat ⋯
37-
mu 4.2 3.3 -2.11 .. 9.90 622 241 1.03 ⋯
38-
theta[Choate] 6.4 5.9 -3.05 .. 19.1 937 572 1.01 ⋯
39-
theta[Deerfield] 5.0 4.9 -4.49 .. 14.2 1214 532 1.01 ⋯
40-
theta[Phillips Andover] 3.4 5.4 -8.17 .. 12.7 1017 511 1.01 ⋯
41-
theta[Phillips Exeter] 4.8 5.2 -4.84 .. 14.5 911 572 1.01 ⋯
42-
theta[Hotchkiss] 3.5 4.8 -6.11 .. 12.0 789 347 1.02 ⋯
43-
theta[Lawrenceville] 3.7 5.2 -6.62 .. 12.6 957 506 1.01 ⋯
44-
theta[St. Paul's] 6.5 5.2 -2.38 .. 18.3 1031 528 1.01 ⋯
45-
theta[Mt. Hermon] 4.8 5.7 -5.52 .. 16.0 1045 538 1.01 ⋯
46-
tau 4.3 3.0 1.06 .. 11.5 214 128 1.03 ⋯
47-
2 columns omitted
36+
mean std eti94 ess_tail ess_bulk rhat mcse_mean mcse_std
37+
mu 4.2 3.3 -2.11 .. 9.90 622 241 1.03 0.21 0.088
38+
theta[Choate] 6.4 5.9 -3.05 .. 19.1 937 572 1.01 0.25 0.20
39+
theta[Deerfield] 5.0 4.9 -4.49 .. 14.2 1214 532 1.01 0.21 0.15
40+
theta[Phillips Andover] 3.4 5.4 -8.17 .. 12.7 1017 511 1.01 0.23 0.17
41+
theta[Phillips Exeter] 4.8 5.2 -4.84 .. 14.5 911 572 1.01 0.21 0.21
42+
theta[Hotchkiss] 3.5 4.8 -6.11 .. 12.0 789 347 1.02 0.25 0.15
43+
theta[Lawrenceville] 3.7 5.2 -6.62 .. 12.6 957 506 1.01 0.22 0.21
44+
theta[St. Paul's] 6.5 5.2 -2.38 .. 18.3 1031 528 1.01 0.22 0.15
45+
theta[Mt. Hermon] 4.8 5.7 -5.52 .. 16.0 1045 538 1.01 0.24 0.23
46+
tau 4.3 3.0 1.06 .. 11.5 214 128 1.03 0.22 0.14
4847
```
4948
5049
Compute the mean, standard deviation, median, and median absolute deviation of the `theta`

0 commit comments

Comments
 (0)