From 6b2bdf6676f8588e4b5196e13d9c83014bcbaf24 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Timoth=C3=A9e=20Poisot?= Date: Wed, 13 Nov 2019 08:50:22 -0500 Subject: [PATCH] :books: minimal documentation page --- docs/make.jl | 5 +++++ docs/src/index.md | 15 +++++++++++++++ src/bioclimaticdata/worldclim.jl | 3 +++ 3 files changed, 23 insertions(+) create mode 100644 docs/make.jl create mode 100644 docs/src/index.md diff --git a/docs/make.jl b/docs/make.jl new file mode 100644 index 00000000..d6d3f49f --- /dev/null +++ b/docs/make.jl @@ -0,0 +1,5 @@ +push!(LOAD_PATH, joinpath("..", "src")) + +using Documenter, SimpleSDMLayers + +makedocs(sitename="Simple SDM Layers") diff --git a/docs/src/index.md b/docs/src/index.md new file mode 100644 index 00000000..691c0f0f --- /dev/null +++ b/docs/src/index.md @@ -0,0 +1,15 @@ +# Simple SDM Layers + +```@docs +SimpleSDMLayer +SimpleSDMResponse +SimpleSDMPredictor +``` + +```@docs +worldclim +``` +```@docs +latitudes +longitudes +``` diff --git a/src/bioclimaticdata/worldclim.jl b/src/bioclimaticdata/worldclim.jl index ca98a475..84fee99e 100644 --- a/src/bioclimaticdata/worldclim.jl +++ b/src/bioclimaticdata/worldclim.jl @@ -87,4 +87,7 @@ Return a single layer from WorldClim 2.0. """ worldclim(layer::Int64; x...) = worldclim([layer]; x...)[1] +""" +Return a range of layers from WorldClim 2.0. +""" worldclim(layers::UnitRange{Int64}; x...) = worldclim(collect(layers); x...)