first commit for docs. Created Project.toml, make.jl, pages.jl and assets.

00krishna · 00krishna · commit 0d0d613d7b61 · 2022-11-07T13:06:55.000-08:00
diff --git a/.gitignore b/.gitignore
@@ -2,3 +2,6 @@
 *.jl.*.cov
 *.jl.mem
 Manifest.toml
+docs/build/
+docs/site/
+.DS_Store
diff --git a/docs/Project.toml b/docs/Project.toml
@@ -0,0 +1,6 @@
+[deps]
+Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
+FiniteDiff = "6a86dc24-6348-571c-b903-95158fe2bd41"
+
+[compat]
+Documenter = "0.27"
diff --git a/docs/make.jl b/docs/make.jl
@@ -0,0 +1,14 @@
+using Documenter, FiniteDiff
+
+include("pages.jl")
+
+makedocs(sitename = "FiniteDiff.jl",
+         authors = "Chris Rackauckas",
+         modules = [FiniteDiff],
+         clean = true,
+         doctest = false,
+         format = Documenter.HTML(assets = ["assets/favicon.ico"],
+                                  canonical = "https://docs.sciml.ai/FiniteDiff/stable/"),
+         pages = pages)
+
+deploydocs(repo = "github.com/SciML/FiniteDiff.jl.git"; push_preview = true)
diff --git a/docs/pages.jl b/docs/pages.jl
@@ -0,0 +1,3 @@
+# Put in a separate page so it can be used by SciMLDocs.jl
+
+pages = ["Home" => "index.md", "finitediff.md"]
diff --git a/docs/src/assets/favicon.ico b/docs/src/assets/favicon.ico
diff --git a/docs/src/assets/logo.png b/docs/src/assets/logo.png

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# Put in a separate page so it can be used by SciMLDocs.jl`
	`2`	`+`
	`3`	`+pages = ["Home" => "index.md", "finitediff.md"]`