Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Build docs with Documenter v1 #311

Merged
merged 11 commits into from
Dec 17, 2023
Merged

Build docs with Documenter v1 #311

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
9da669a
Require Documenter v1
sethaxen Dec 17, 2023
6f65253
Use correct analytics syntax
sethaxen Dec 17, 2023
bd804a1
Declare prettyurl
sethaxen Dec 17, 2023
f42ef3b
Specify exceptions where warnings are raised
sethaxen Dec 17, 2023
03d7a84
Avoid errors when not using pretty urls
sethaxen Dec 17, 2023
b79f336
Allow PlutoStaticHTML build files to exceed size limit
sethaxen Dec 17, 2023
05e7599
Merge branch 'main' into documenterv1
sethaxen Dec 17, 2023
0cd4c2d
Always warn on missing cross-references
sethaxen Dec 17, 2023
731294b
Cache downloaded CmdStan
sethaxen Dec 17, 2023
5a9e654
Avoid status 301 redirects
sethaxen Dec 17, 2023
266acc9
Always check links
sethaxen Dec 17, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .github/workflows/documenter.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,12 @@ jobs:
key: ${{ runner.os }}-${{ env.cache-name }}-${{ hashFiles('docs/CondaPkg.toml') }}
restore-keys: |
${{ runner.os }}-${{ env.cache-name }}-
- name: Cache CmdStan
id: cache-cmdstan
uses: actions/cache@v2
with:
path: ${{ env.CMDSTAN_PATH }}
key: cmdstan-${{ env.CMDSTAN_VERSION }}-${{ runner.os }}
- name: Download and build CmdStan
if: steps.cache-cmdstan.outputs.cache-hit != 'true'
run: |
Expand Down
2 changes: 1 addition & 1 deletion docs/Project.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ CairoMakie = "0.8.9, 0.9, 0.10"
DataFrames = "1"
DimensionalData = "0.23, 0.24"
Distributions = "0.25"
Documenter = "0.27"
Documenter = "1"
EvoTrees = "0.14.8, 0.15, 0.16"
MCMCDiagnosticTools = "0.3"
MLJBase = "1"
Expand Down
16 changes: 12 additions & 4 deletions docs/make.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,14 @@ doctestfilters = [
r"\s+\"created_at\" => .*", # ignore timestamps in doctests
]

prettyurls = haskey(ENV, "CI")

warnonly = [
:missing_docs, # we don't reexport or document all of MCMCDiagnosticTools
:cross_references, # we reference the pages built by PlutoStaticHTML with pretty relative URLs
:linkcheck, # avoid checking links to pages built with PlutoStaticHTML
]

makedocs(;
modules,
sitename="ArviZ.jl",
Expand All @@ -90,16 +98,16 @@ makedocs(;
],
checkdocs=:exports,
format=Documenter.HTML(;
prettyurls=haskey(ENV, "CI"),
prettyurls,
size_threshold=2 * 10^6, # 2Mb, needed since PlutoStaticHTML embeds images in markdown
assets=["assets/favicon.ico", "assets/custom.css"],
sidebar_sitename=false,
canonical="stable",
analytics="G-W1G68W77YV",
),
doctestfilters,
linkcheck=true,
analytics="G-W1G68W77YV",
# allow linkcheck to fail so we can use pretty links to PlutoStaticHTML notebooks
strict=Documenter.except(:footnote, :linkcheck, :missing_docs),
warnonly,
)

deploydocs(; repo="github.com/arviz-devs/ArviZ.jl.git", devbranch="main", push_preview=true)
12 changes: 6 additions & 6 deletions docs/src/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@ ArviZ.jl is a Julia meta-package for exploratory analysis of Bayesian models.
It is part of the [ArviZ project](https://www.arviz.org/), which also includes a related [Python package](https://python.arviz.org/).

ArviZ consists of and re-exports the following subpackages, along with extensions integrating them with InferenceObjects:
- [InferenceObjects.jl](https://julia.arviz.org/InferenceObjects): a base package implementing the [`InferenceData`](@ref) type with utilities for building, saving, and working with it
- [MCMCDiagnosticTools.jl](https://julia.arviz.org/MCMCDiagnosticTools): diagnostics for Markov Chain Monte Carlo methods
- [PSIS.jl](https://julia.arviz.org/PSIS): Pareto-smoothed importance sampling
- [PosteriorStats.jl](https://julia.arviz.org/PosteriorStats): common statistical analyses for the Bayesian workflow
- [InferenceObjects.jl](https://julia.arviz.org/InferenceObjects/): a base package implementing the [`InferenceData`](@ref) type with utilities for building, saving, and working with it
- [MCMCDiagnosticTools.jl](https://julia.arviz.org/MCMCDiagnosticTools/): diagnostics for Markov Chain Monte Carlo methods
- [PSIS.jl](https://julia.arviz.org/PSIS/): Pareto-smoothed importance sampling
- [PosteriorStats.jl](https://julia.arviz.org/PosteriorStats/): common statistical analyses for the Bayesian workflow

Additional functionality can be loaded with the following packages:
- [ArviZExampleData.jl](https://julia.arviz.org/ArviZExampleData): example `InferenceData` objects, useful for demonstration and testing
- [ArviZPythonPlots.jl](https://julia.arviz.org/ArviZPythonPlots): Python ArviZ's library of plotting functions for Julia types
- [ArviZExampleData.jl](https://julia.arviz.org/ArviZExampleData/): example `InferenceData` objects, useful for demonstration and testing
- [ArviZPythonPlots.jl](https://julia.arviz.org/ArviZPythonPlots/): Python ArviZ's library of plotting functions for Julia types

See the navigation bar for more useful packages.

Expand Down
Loading