docs

Author: YoungFaithful

docs/make.jl

@@ -11,10 +11,7 @@ makedocs(sitename="ClustForOpt.jl",
         "Clustering" => "clust.md",
         "Optimization" => "opt.md"
         ],
-    formats = Any[
-        Documenter.HTML(
-            assets = ["assets/clust_for_opt_text.svg"]
-        )]
+    format = Documenter.HTML(assets=["assets/clust_for_opt_text.svg"])
     )
 
 deploydocs(repo = "github.com/holgerteichgraeber/ClustForOpt.jl.git")

docs/src/clust.md

@@ -36,8 +36,8 @@ ClustResultSimple
 ## Example running clustering
 ```@example
 using ClustForOpt
-# load ts-input-data
-ts_input_data = load_timeseries_data(normpath(joinpath(@__DIR__,"..","data","TS_GER_1")); T=24, years=[2016])
+# laod ts-input-data
+ts_input_data = load_timeseries_data(normpath(joinpath(@__DIR__,"..","..","data","TS_GER_1")); T=24, years=[2016])
 ts_clust_data = run_clust(ts_input_data).best_results
 using Plots
 plot(ts_clust_data.data["solar-germany"], legend=false, linestyle=:solid, width=3, xlabel="Time [h]", ylabel="Solar availability factor [%]")

docs/src/load_data.md

@@ -17,7 +17,7 @@ load_timeseries_data
 ```@example
 using ClustForOpt
 # laod ts-input-data
-ts_input_data = load_timeseries_data(normpath(joinpath(@__DIR__,"..","data","TS_GER_1")); T=24, years=[2016])
+ts_input_data = load_timeseries_data(normpath(joinpath(@__DIR__,"..","..","data","TS_GER_1")); T=24, years=[2016])
 using Plots
 plot(ts_input_data.data["solar-germany"], legend=false, linestyle=:dot, xlabel="Time [h]", ylabel="Solar availability factor [%]")
 savefig("load_timeseries_data.svg")