docs

pszufe · Mar 11, 2019 · 697219a · 697219a
1 parent 19336c4
commit 697219a
Show file tree

Hide file tree

Showing 5 changed files with 59 additions and 0 deletions.
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,2 @@
+[deps]
+Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
diff --git a/docs/make.jl b/docs/make.jl
@@ -0,0 +1,28 @@
+using Documenter
+
+try
+    using OpenStreetMapXDES
+catch
+    if !("../src/" in LOAD_PATH)
+       push!(LOAD_PATH,"../src/")
+       @info "Added \"../src/\"to the path: $LOAD_PATH "
+       using OpenStreetMapXDES
+    end
+end
+
+makedocs(
+    sitename = "OpenStreetMapXDES",
+    format = format = Documenter.HTML(
+        prettyurls = get(ENV, "CI", nothing) == "true"
+    ),
+    modules = [OpenStreetMapXDES],
+    pages = ["index.md", "reference.md"],
+    doctest = true
+)
+
+
+
+deploydocs(
+    repo ="github.com/pszufe/OpenStreetMapXDES.jl.git",
+    target="build"
+)
diff --git a/docs/src/index.md b/docs/src/index.md
@@ -0,0 +1,6 @@
+# OpenStreetMapXDES.jl
+
+Documentation for OpenStreetMapXDES.jl
+
+For details please go to the [Reference](https://pszufe.github.io/OpenStreetMapXDES.jl/latest/reference/) section.
+
diff --git a/docs/src/reference.md b/docs/src/reference.md
@@ -0,0 +1,21 @@
+Reference
+=========
+
+```@meta
+CurrentModule = OpenStreetMapXDES
+DocTestSetup = quote
+    using OpenStreetMapX
+	using OpenStreetMapXDES
+end
+```
+
+Simulation functions
+----------------------
+
+```@docs
+```
+
+
+```@meta
+DocTestSetup = nothing
+```