diff --git a/Project.toml b/Project.toml index 3150d03..4741e43 100644 --- a/Project.toml +++ b/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" diff --git a/docs/.gitignore b/docs/.gitignore new file mode 100644 index 0000000..a303fff --- /dev/null +++ b/docs/.gitignore @@ -0,0 +1,2 @@ +build/ +site/ diff --git a/docs/Project.toml b/docs/Project.toml new file mode 100644 index 0000000..dfa65cd --- /dev/null +++ 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 new file mode 100644 index 0000000..4371c07 --- /dev/null +++ b/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 = "" +)=# diff --git a/docs/src/apis.md b/docs/src/apis.md new file mode 100644 index 0000000..ab2478d --- /dev/null +++ b/docs/src/apis.md @@ -0,0 +1,8 @@ +# API list + +```@index +``` + +```@autodocs +Modules = [CoordVisualize] +``` diff --git a/docs/src/index.md b/docs/src/index.md new file mode 100644 index 0000000..f3b47c1 --- /dev/null +++ b/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). diff --git a/src/CoordVisualize.jl b/src/CoordVisualize.jl index e0a8927..a6660aa 100644 --- a/src/CoordVisualize.jl +++ b/src/CoordVisualize.jl @@ -5,5 +5,6 @@ using Dates include("typedef.jl") include("parser.jl") include("edit.jl") +include("print.jl") end # module CoordVisualize diff --git a/src/print.jl b/src/print.jl new file mode 100644 index 0000000..e69de29 diff --git a/src/typedef.jl b/src/typedef.jl index 7f722ba..83f125a 100644 --- a/src/typedef.jl +++ b/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