Use Literate for the main tutorial (#242)

* ignore files from logo * make a Literate.jl version of the tutorial * add GUI example in the docs * make literate convert tutorial * add solver comparisons * add literate * fix # insreawd of ## * fix latex dispaly
JuliaDynamics · Aug 20, 2024 · f7a23b1 · f7a23b1
1 parent 3e4afaa
commit f7a23b1
Show file tree

Hide file tree

Showing 6 changed files with 510 additions and 457 deletions.
diff --git a/.gitignore b/.gitignore
@@ -6,4 +6,6 @@ update*
 Manifest.toml
 *.scss
 *.css
-*style.jl
+*style.jl
+*.png
+*.mp4
diff --git a/Project.toml b/Project.toml
@@ -1,7 +1,7 @@
 name = "DynamicalSystems"
 uuid = "61744808-ddfa-5f27-97ff-6e42cc95d634"
 repo = "https://github.com/JuliaDynamics/DynamicalSystems.jl.git"
-version = "3.3.17"
+version = "3.3.18"
 
 [deps]
 Attractors = "f3fd9213-ca85-4dba-9dfd-7fc91308fec7"

diff --git a/docs/Project.toml b/docs/Project.toml
@@ -15,3 +15,4 @@ RecurrenceAnalysis = "639c3291-70d9-5ea2-8c5b-839eba1ee399"
 StateSpaceSets = "40b095a5-5852-4c12-98c7-d43bf788e795"
 Statistics = "10745b16-79ce-11e8-11f9-7d13ad32a3b2"
 FractalDimensions = "4665ce21-e117-4649-aed8-08bbe5ccbead"
+Literate = "98b081ad-f1c9-55d3-8b20-4c87d4299306"
diff --git a/docs/make.jl b/docs/make.jl
@@ -10,6 +10,12 @@ Downloads.download(
 )
 include("build_docs_with_style.jl")
 
+import Literate
+Literate.markdown(
+    joinpath(@__DIR__, "src", "tutorial.jl"), joinpath(@__DIR__, "src");
+    credit = false
+)
+
 pages =  [
     "Introduction" => "index.md",
     "Overarching tutorial" => "tutorial.md",