docs

docs/Project.toml

@@ -0,0 +1,19 @@
+[deps]
+CairoMakie = "13f3f980-e62b-5c42-98c6-ff1f3baf88f0"
+ColorSchemes = "35d6a980-a343-548e-a6ea-1d62b119f2f4"
+Colors = "5ae59095-9a9b-59fe-a467-6f913c188581"
+DSP = "717857b8-e6f2-59f4-9121-6e50c889abd2"
+DataFrames = "a93c6f00-e57d-5684-b7b6-d8193f3e46c0"
+DataFramesMeta = "1313f7d8-7da2-5740-9ea0-a2ca25f37964"
+DocStringExtensions = "ffbed154-4ef7-542d-bbb7-c09d3a79fcae"
+Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
+Glob = "c27321d9-0574-5035-807b-f59d2c89b15c"
+Literate = "98b081ad-f1c9-55d3-8b20-4c87d4299306"
+MakieThemes = "e296ed71-da82-5faf-88ab-0034a9761098"
+Random = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"
+Statistics = "10745b16-79ce-11e8-11f9-7d13ad32a3b2"
+StatsModels = "3eaba693-59b7-5ba5-a881-562e759f1c8d"
+TopoPlots = "2bdbdf9c-dbd8-403f-947b-1a4e0dd41a7a"
+Unfold = "181c99d8-e21b-4ff3-b70b-c233eddec679"
+UnfoldMakie = "69a5ce3b-64fb-4f22-ae69-36dd4416af2a"
+UnfoldSim = "ed8ae6d2-84d3-44c6-ab46-0baf21700804"

docs/make.jl

@@ -0,0 +1,47 @@
+using ERPgnostics
+using Documenter
+using DocStringExtensions
+
+# preload once
+
+using CairoMakie
+const Makie = CairoMakie # - for references
+using AlgebraOfGraphics
+using Unfold
+using DataFrames
+using DataFramesMeta
+using Literate
+using Glob
+
+GENERATED = joinpath(@__DIR__, "src", "generated")
+SOURCE = joinpath(@__DIR__, "literate")
+for subfolder ∈ ["how_to", "intro", "tutorials", "explanations"]
+    local SOURCE_FILES = Glob.glob(subfolder * "/*.jl", SOURCE)
+    foreach(fn -> Literate.markdown(fn, GENERATED * "/" * subfolder), SOURCE_FILES)
+end
+
+DocMeta.setdocmeta!(ERPgnostics, :DocTestSetup, :(using ERPgnostics); recursive = true)
+
+makedocs(;
+    modules = [ERPgnostics],
+    authors = "Vladimir Mikheev, Benedikt Ehinger",
+    repo = Documenter.Remotes.GitHub("unfoldtoolbox", "ERPgnostics.jl"),
+    sitename = "ERPgnostics.jl",
+    warnonly = :cross_references,
+    format = Documenter.HTML(;
+        prettyurls = get(ENV, "CI", "false") == "true",
+        canonical = "https://unfoldtoolbox.github.io/ERPgnostics.jl",
+        assets = String[],
+    ),
+    pages = [
+        "ERPgnostics Documentation" => "index.md",
+        "API / DocStrings" => "api.md",
+    ],
+)
+
+deploydocs(;
+    repo = "github.com/unfoldtoolbox/ERPgnostics.jl",
+    devbranch = "main",
+    versions = "v#.#",
+    push_preview = true,
+)

docs/src/api.md

@@ -0,0 +1,6 @@
+```@autodocs
+Modules = [ERPgnostics]
+Order   = [:function]
+```
+
+Internally, we use a `PlotConfig` struct to keep track of common plotting options, so that all functions have a similar API.

docs/src/index.md

@@ -0,0 +1,3 @@
+# ERPgnostics Documentation
+
+# Hello World!