Skip to content
Snippets Groups Projects
Commit d8687d65 authored by Brian Groenke's avatar Brian Groenke
Browse files

Fix out of date doc build

parent 6ceac6ee
No related branches found
No related tags found
No related merge requests found
[deps] [deps]
ArgParse = "c7e460c6-2fb9-53a9-8c5b-16f535851c63"
CryoGrid = "a535b82e-5f3d-4d97-8b0b-d6483f5bebd5" CryoGrid = "a535b82e-5f3d-4d97-8b0b-d6483f5bebd5"
Distributions = "31c24e10-a181-5473-b8eb-7969acd0382f" Distributions = "31c24e10-a181-5473-b8eb-7969acd0382f"
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4" Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
......
using ArgParse
using CryoGrid using CryoGrid
using Documenter using Documenter
using Literate using Literate
# ENV["LOCALDOCS"] = "true" s = ArgParseSettings()
@add_arg_table! s begin
"--local", "-l"
action = :store_true
help = "Local docs build mode"
"--draft", "-d"
action = :store_true
help = "Whether to build docs in draft mode, i.e. skipping execution of examples and doctests"
end
parsed_args = parse_args(ARGS, s)
IS_LOCAL = haskey(ENV,"LOCALDOCS") && ENV["LOCALDOCS"] == "true" IS_LOCAL = parsed_args["local"] || parse(Bool, get(ENV, "LOCALDOCS", "false"))
IS_DRAFT = parsed_args["draft"] || parse(Bool, get(ENV, "DRAFTDOCS", "false"))
if haskey(ENV, "GITHUB_ACTIONS") if haskey(ENV, "GITHUB_ACTIONS")
ENV["JULIA_DEBUG"] = "Documenter" ENV["JULIA_DEBUG"] = "Documenter"
end end
...@@ -22,7 +33,6 @@ const modules = [ ...@@ -22,7 +33,6 @@ const modules = [
CryoGrid.Soils, CryoGrid.Soils,
CryoGrid.Snow, CryoGrid.Snow,
CryoGrid.Surface, CryoGrid.Surface,
CryoGrid.Presets,
CryoGrid.Diagnostics, CryoGrid.Diagnostics,
# solvers # solvers
CryoGrid.DiffEq, CryoGrid.DiffEq,
...@@ -65,6 +75,7 @@ example_docpages = map(example_docfiles) do f ...@@ -65,6 +75,7 @@ example_docpages = map(example_docfiles) do f
end end
makedocs( makedocs(
repo=Remotes.GitHub("CryoGrid", "CryoGrid.jl"),
modules=modules, modules=modules,
sitename="CryoGrid.jl", sitename="CryoGrid.jl",
authors="Brian Groenke, Moritz Langer, Jan Nitzbon", authors="Brian Groenke, Moritz Langer, Jan Nitzbon",
...@@ -73,6 +84,8 @@ makedocs( ...@@ -73,6 +84,8 @@ makedocs(
canonical = "https://cryogrid.github.io/CryoGrid.jl/v0", canonical = "https://cryogrid.github.io/CryoGrid.jl/v0",
), ),
warnonly=true, # don't fail when there are errors warnonly=true, # don't fail when there are errors
doctest=!IS_DRAFT,
draft=IS_DRAFT,
pages=["Home" => "index.md", pages=["Home" => "index.md",
"Installation" => "installation.md", "Installation" => "installation.md",
"Getting Started" => "quickstart.md", "Getting Started" => "quickstart.md",
...@@ -107,7 +120,6 @@ makedocs( ...@@ -107,7 +120,6 @@ makedocs(
"CryoGridLite" => "api/solvers/lite_implicit.md", "CryoGridLite" => "api/solvers/lite_implicit.md",
], ],
"Diagnostics" => "api/diagnostics.md", "Diagnostics" => "api/diagnostics.md",
"Presets" => "api/presets.md",
], ],
]) ])
......
# Presets (@)
```@autodocs
Modules = [CryoGrid.Presets]
Private = false
Order = [:type, :function, :macro]
```
\ No newline at end of file
...@@ -27,7 +27,6 @@ The `CryoGrid` module provided by CryoGrid.jl is organized into a series of subm ...@@ -27,7 +27,6 @@ The `CryoGrid` module provided by CryoGrid.jl is organized into a series of subm
|`Tiles`|Defines the `Tile` and `Stratigraphy` types for constructing 1D land models.|`Utils`,`Numerics`,`InputOutput`| |`Tiles`|Defines the `Tile` and `Stratigraphy` types for constructing 1D land models.|`Utils`,`Numerics`,`InputOutput`|
|`DiffEq`|Provides dispatches and utilities for integrating with solvers from the SciML `OrdinaryDiffEq` package.|`Utils`,`Numerics`,`InputOutput`| |`DiffEq`|Provides dispatches and utilities for integrating with solvers from the SciML `OrdinaryDiffEq` package.|`Utils`,`Numerics`,`InputOutput`|
|`LiteImplicit`|Provides an implementation of the `CryoGridLite` solver scheme from Langer et al. 2023.|`Utils`,`Numerics`| |`LiteImplicit`|Provides an implementation of the `CryoGridLite` solver scheme from Langer et al. 2023.|`Utils`,`Numerics`|
|`Presets`|Provides pre-defined stratigraphies, forcings, and layer configurations to facilitate rapid prototyping.|`Utils`,`Numerics`,`InputOutput`,`Heat`,`Hydrology`,`Soils`|
Note that all submodules depend on the top-level `CryoGrid` module which declares all of the "core" types and [method interfaces](https://docs.julialang.org/en/v1/manual/interfaces/) for defining model behavior. Each submodule may additionally define its own method interfaces related to its own specific process(es) or layer(s). Note that all submodules depend on the top-level `CryoGrid` module which declares all of the "core" types and [method interfaces](https://docs.julialang.org/en/v1/manual/interfaces/) for defining model behavior. Each submodule may additionally define its own method interfaces related to its own specific process(es) or layer(s).
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment