Setup Documenter

Closes issue #10.
JuliaFEM · Jul 24, 2018 · 70e3167 · 70e3167
1 parent 32cbf10
commit 70e3167
Show file tree

Hide file tree

Showing 5 changed files with 38 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,4 @@
 *.jl.cov
 *.jl.*.cov
 *.jl.mem
+docs/site
diff --git a/docs/deploy.jl b/docs/deploy.jl
@@ -0,0 +1,10 @@
+# This file is a part of JuliaFEM.
+# License is MIT: see https://github.com/JuliaFEM/BoundingSphere.jl/blob/master/LICENSE
+
+using Documenter
+
+deploydocs(
+ repo = "github.com/JuliaFEM/BoundingSphere.jl.git",
+ julia = "0.6",
+ deps = nothing,
+ make = nothing)
diff --git a/docs/make.jl b/docs/make.jl
@@ -0,0 +1,12 @@
+# This file is a part of JuliaFEM.
+# License is MIT: see https://github.com/JuliaFEM/BoundingSphere.jl/blob/master/LICENSE
+
+using Documenter
+using BoundingSphere
+
+makedocs(modules=[BoundingSphere],
+ format = :html,
+ checkdocs = :all,
+ sitename = "BoundingSphere.jl",
+ analytics = "UA-83590644-1",
+ pages = ["index.md", "api.md"])
diff --git a/docs/src/api.md b/docs/src/api.md
@@ -0,0 +1,5 @@
+## API Documentation
+
+```@autodocs
+Modules = [BoundingSphere]
+```
diff --git a/docs/src/index.md b/docs/src/index.md
@@ -0,0 +1,10 @@
+# Introduction
+
+Package contains algorithms to calculate smallest enclosing sphere for a given
+set of points in N dimensions.
+
+```@meta
+DocTestSetup = quote
+ using BoundingSphere
+end
+```