Add docs

PTsolvers · Sep 13, 2023 · 8005d0d · 8005d0d
1 parent bb7441b
commit 8005d0d
Show file tree

Hide file tree

Showing 6 changed files with 30 additions and 1 deletion.
diff --git a/docs/.gitignore b/docs/.gitignore
@@ -0,0 +1,2 @@
+build/
+site/
diff --git a/docs/Project.toml 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
@@ -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
diff --git a/docs/src/index.md 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
@@ -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