adding docs to dev

jlchan · Jan 11, 2021 · 6243fd5 · 6243fd5
1 parent f288b8b
commit 6243fd5
Show file tree

Hide file tree

Showing 5 changed files with 43 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -4,3 +4,5 @@
 .DS_Store
 /dev/
 Manifest.toml
+docs/Manifest.toml
+docs/build
diff --git a/docs/Project.toml b/docs/Project.toml
@@ -0,0 +1,8 @@
+[deps]
+Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
+DocumenterTools = "35a29f4d-8980-5a13-9543-d66fff28ecb8"
+StartUpDG = "472ebc20-7c99-4d4b-9470-8fde4e9faa0f"
+
+[compat]
+Documenter = "0.25"
+DocumenterTools = "0.1"
diff --git a/docs/make.jl b/docs/make.jl
@@ -0,0 +1,16 @@
+using Documenter
+using StartUpDG
+
+makedocs(
+    sitename = "StartUpDG.jl",
+    repo = "https://github.com/jlchan/StartUpDG.jl",
+    modules=[StartUpDG],
+    pages = [
+        "Home" => "index.md",
+        "Authors" => "authors.md"
+    ]
+)
+
+deploydocs(
+    repo = "github.com/jlchan/StartUpDG.jl",
+)
diff --git a/docs/src/authors.md b/docs/src/authors.md
@@ -0,0 +1,3 @@
+## Authors
+
+The original port from Matlab to Julia was done by [Yimin Lin](https://github.com/yiminllin). Subsequent development was done by [Jesse Chan](https://jlchan.github.io).
diff --git a/docs/src/index.md b/docs/src/index.md
@@ -0,0 +1,14 @@
+# StartUpDG
+
+Todo: finish
+
+## Index
+
+```@index
+```
+
+## Functions
+
+```@autodocs
+Modules = [StartUpDG]
+```
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		## Authors

		The original port from Matlab to Julia was done by [Yimin Lin](https://github.com/yiminllin). Subsequent development was done by [Jesse Chan](https://jlchan.github.io).