adding doc

Project.toml

@@ -6,6 +6,7 @@ version = "0.1.0"
 [deps]
 ColorSchemes = "35d6a980-a343-548e-a6ea-1d62b119f2f4"
 Dates = "ade2ca70-3891-5945-98fb-dc099432e06a"
+Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
 GLMakie = "e9467ef8-e4e7-5192-8a1a-b1aee30e663a"
 YAML = "ddb6d928-2868-570f-bddf-ab3f9cf99eb6"
 

docs/.gitignore

@@ -0,0 +1,2 @@
+build/
+site/

docs/Project.toml

@@ -0,0 +1,2 @@
+[deps]
+Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"

docs/make.jl

@@ -0,0 +1,19 @@
+using Documenter
+using CoordVisualize
+
+makedocs(
+    sitename = "CoordVisualize",
+    format = Documenter.HTML(),
+    modules = [CoordVisualize],
+    pages = [
+        "Top" => "index.md",
+        "API list" => "apis.md"
+    ]
+)
+
+# Documenter can also automatically deploy documentation to gh-pages.
+# See "Hosting Documentation" and deploydocs() in the Documenter manual
+# for more information.
+#=deploydocs(
+    repo = "<repository url>"
+)=#

docs/src/apis.md

@@ -0,0 +1,8 @@
+# API list
+
+```@index
+```
+
+```@autodocs
+Modules = [CoordVisualize]
+```

docs/src/index.md

@@ -0,0 +1,27 @@
+```@meta
+CurrentModule = CoordVisualize
+```
+
+# CoordVisualize.jl
+
+Documentation for CoordVisualize.jl
+
+## Tutorial
+Readers are expected to be familiar with basics of julia.
+
+### Log structure
+CoordVisualize.jl treats coordination trace log with some additional information,
+datetime when log was taken and supplemental note to annotate the log.
+This set of log is represented by the type [`CoordLog`](@ref).
+
+### Parsing Log
+Use [`parse_log`](@ref) to parse log files generated with Tracecoords CSM mod.
+Set the keyword argument `interactive` to `true` to supply notes interactively.
+It automatically get datetime.
+Notes can be also supplied in the following section.
+
+### Editing
+You sometimes want to split logs and to give more appropriate notes for each of them.
+You can do this with [`split_log`](@ref) function.
+
+You can also edit existing notes with [`assign_note!`](@ref).

src/CoordVisualize.jl

@@ -5,5 +5,6 @@ using Dates
 include("typedef.jl")
 include("parser.jl")
 include("edit.jl")
+include("print.jl")
 
 end # module CoordVisualize

src/typedef.jl

@@ -1,4 +1,7 @@
 using Dates
+"""
+Stores a set of logs with its taken date datetime and supplemental note.
+"""
 mutable struct CoordLog{T <: AbstractFloat}
     coords::Matrix{T}
     logdate::DateTime