From 70e3167bba4305e1562fe3007abf9a1ab2977530 Mon Sep 17 00:00:00 2001 From: Jukka Aho Date: Tue, 24 Jul 2018 09:59:43 +0300 Subject: [PATCH] Setup Documenter Closes issue #10. --- .gitignore | 1 + docs/deploy.jl | 10 ++++++++++ docs/make.jl | 12 ++++++++++++ docs/src/api.md | 5 +++++ docs/src/index.md | 10 ++++++++++ 5 files changed, 38 insertions(+) create mode 100644 docs/deploy.jl create mode 100644 docs/make.jl create mode 100644 docs/src/api.md create mode 100644 docs/src/index.md diff --git a/.gitignore b/.gitignore index 8c960ec..9e77d3e 100644 --- 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 new file mode 100644 index 0000000..85d71cd --- /dev/null +++ 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 new file mode 100644 index 0000000..5365fae --- /dev/null +++ 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 new file mode 100644 index 0000000..0032261 --- /dev/null +++ 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 new file mode 100644 index 0000000..9d267b6 --- /dev/null +++ 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 +```