diff --git a/docs/.gitignore b/docs/.gitignore new file mode 100644 index 00000000..a303fff2 --- /dev/null +++ b/docs/.gitignore @@ -0,0 +1,2 @@ +build/ +site/ diff --git a/docs/Project.toml b/docs/Project.toml new file mode 100644 index 00000000..3a52a5db --- /dev/null +++ b/docs/Project.toml @@ -0,0 +1,5 @@ +[deps] +Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4" + +[compat] +Documenter = "0.27" diff --git a/docs/make.jl b/docs/make.jl new file mode 100644 index 00000000..ff0dfb53 --- /dev/null +++ b/docs/make.jl @@ -0,0 +1,19 @@ +using Documenter +using FastIce + +push!(LOAD_PATH,"../src/") + +makedocs( + sitename = "FastIce", + authors="Ludovic Räss, Ivan utkin and contributors", + format = Documenter.HTML(; prettyurls=get(ENV, "CI", nothing) == "true"), # easier local build + modules = [FastIce], + pages=[ + "Home" => "index.md", + ] +) + +deploydocs( + repo = "github.com/PTsolvers/FastIce.jl.git", + devbranch = "main" +) diff --git a/docs/src/assets/logo.png b/docs/src/assets/logo.png new file mode 100644 index 00000000..e0c6753c Binary files /dev/null and b/docs/src/assets/logo.png differ diff --git a/docs/src/index.md b/docs/src/index.md new file mode 100644 index 00000000..0b8c3323 --- /dev/null +++ b/docs/src/index.md @@ -0,0 +1,3 @@ +# FastIce.jl + +Documentation for FastIce.jl diff --git a/src/FastIce.jl b/src/FastIce.jl index 29cf051c..72fb62ca 100644 --- a/src/FastIce.jl +++ b/src/FastIce.jl @@ -14,6 +14,6 @@ include("physics.jl") include("BoundaryConditions/boundary_conditions.jl") include("Models/models.jl") -include("distributed.jl") +# include("Distributed/distributed.jl") end # module