This repository was archived by the owner on Mar 1, 2023. It is now read-only.

ClimateMachine Documentation

Jump to bottom

Jake Bolewski edited this page Dec 23, 2020 · 10 revisions

Documentation Overview

ClimateMachine.jl uses Documenter.jl to convert markdown + extensions markup to html.

Previews for PR's can be viewed at: https://clima.github.io/ClimateMachine.jl/previews/PR<number>

Infrastructure

ClimateMachine.jl uses two different systems to build documentation and upload documentation previews for PR's:

GithubActions - Runs every pushed commit, every commit will kill any previously running stale builds. Doc builds run with tutorial generation disabled to limit the doc build / turnaround times.
Buildkite - Runs on bors try and bors merge on Caltech's central cluster.
Progress of triggered build pipelines can be monitored at https://buildkite.com/clima/climatemachine-docs. bors try runs will build tutorials in parallel in addition to API documentation after the tutorial assets are rendered. The built preview for bors try runs are pushed to the same preview url as the PR preview URL.