added liveserver, moved literate

unfoldtoolbox · Oct 25, 2023 · 372accc · 372accc
1 parent 208fa4c
commit 372accc
Show file tree

Hide file tree

Showing 9 changed files with 10 additions and 6 deletions.
diff --git a/.gitignore b/.gitignore
@@ -7,4 +7,4 @@
 
 /Manifest.toml
 /docs/build/
-/docs/src/literate/*/*.md
+/docs/src/generated
diff --git a/docs/src/literate/plot_results_styling.jl → docs/literate/plot_results_styling.jl b/docs/src/literate/plot_results_styling.jl → docs/literate/plot_results_styling.jl
diff --git a/docs/src/literate/reference/positions.jl → docs/literate/reference/positions.jl b/docs/src/literate/reference/positions.jl → docs/literate/reference/positions.jl
diff --git a/docs/src/literate/reference/positions.md → docs/literate/reference/positions.md b/docs/src/literate/reference/positions.md → docs/literate/reference/positions.md
diff --git a/docs/src/literate/tutorials/circTopo.jl → docs/literate/tutorials/circTopo.jl b/docs/src/literate/tutorials/circTopo.jl → docs/literate/tutorials/circTopo.jl
diff --git a/docs/src/literate/tutorials/erp.jl → docs/literate/tutorials/erp.jl b/docs/src/literate/tutorials/erp.jl → docs/literate/tutorials/erp.jl
diff --git a/docs/make.jl b/docs/make.jl
@@ -14,9 +14,10 @@ using DataFramesMeta
 using Literate
 using Glob
 
-GENERATED = joinpath(@__DIR__, "src", "literate")
+GENERATED = joinpath(@__DIR__, "src", "generated")
+SOURCE = joinpath(@__DIR__, "literate")
 for subfolder ∈ ["explanations", "HowTo", "tutorials", "reference"]
-    local SOURCE_FILES = Glob.glob(subfolder * "/*.jl", GENERATED)
+    local SOURCE_FILES = Glob.glob(subfolder * "/*.jl", SOURCE)
     foreach(fn -> Literate.markdown(fn, GENERATED * "/" * subfolder), SOURCE_FILES)
 
 end
@@ -37,14 +38,14 @@ makedocs(;
     pages=[
         "UnfoldMakie Documentation" => "index.md",
         "Visualizations-Types" => [
-            "ERP plot" => "literate/tutorials/erp.md",
+            "ERP plot" => "generated/tutorials/erp.md",
             "Butterfly Plot" => "tutorials/butterfly.md",
             "Designmatrix" => "tutorials/designmatrix.md",
             "ERP Image" => "tutorials/erpimage.md",
             "Parallel Coordinates Plot" => "tutorials/parallelcoordinates.md",
             "Topo Plot" => "tutorials/topoplot.md",
             "Topo Plot Series" => "tutorials/topoplotseries.md",
-            "Circular TopoPlot" => "literate/tutorials/circTopo.md",
+            "Circular TopoPlot" => "generated/tutorials/circTopo.md",
         ],
         "How To" => [
             "Butterfly Colormap" => "how_to/position2color.md",
@@ -54,7 +55,7 @@ makedocs(;
             "Show out of Bounds Label" => "how_to/show_oob_labels.md",
         ],
         "Reference" => [
-            "Convert 3D positions / montages to 2D layouts" => "literate/reference/positions.md"
+            "Convert 3D positions / montages to 2D layouts" => "generated/reference/positions.md"
 
         ],
         "API" => "api.md",

diff --git a/docs/run_liveserver.jl b/docs/run_liveserver.jl
@@ -0,0 +1,3 @@
+using LiveServer
+servedocs(skip_dir=joinpath("src","generated"),literate_dir=joinpath("literate"),foldername=".")
+
diff --git a/docs/assets/logo.svg → docs/src/assets/logo.svg b/docs/assets/logo.svg → docs/src/assets/logo.svg
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		using LiveServer
		servedocs(skip_dir=joinpath("src","generated"),literate_dir=joinpath("literate"),foldername=".")