Update documentation

KeitaNakamura · Aug 19, 2024 · f95c73b · f95c73b
1 parent b907a07
commit f95c73b
Show file tree

Hide file tree

Showing 9 changed files with 17 additions and 17 deletions.
diff --git a/docs/literate.jl b/docs/literate.jl
@@ -1,14 +1,14 @@
 using Literate
 
-const EXAMPLES = ["collision.jl",
-                  "tlmpm_vortex.jl",
-                  "implicit_jacobian_free.jl",
-                  "implicit_jacobian_based.jl",
-                  "dam_break.jl",
-                  "rigid_body_contact.jl"]
+const TUTORIALS = ["collision.jl",
+                   "tlmpm_vortex.jl",
+                   "implicit_jacobian_free.jl",
+                   "implicit_jacobian_based.jl",
+                   "dam_break.jl",
+                   "rigid_body_contact.jl"]
 
-for filename in EXAMPLES
-    path = joinpath(@__DIR__, "literate/examples", filename)
-    outputdir = joinpath(@__DIR__, "src/examples")
+for filename in TUTORIALS
+    path = joinpath(@__DIR__, "literate/tutorials", filename)
+    outputdir = joinpath(@__DIR__, "src/tutorials")
     Literate.markdown(path, outputdir; codefence="```julia" => "```")
 end
diff --git a/docs/literate/examples/collision.jl → docs/literate/tutorials/collision.jl b/docs/literate/examples/collision.jl → docs/literate/tutorials/collision.jl
diff --git a/docs/literate/examples/dam_break.jl → docs/literate/tutorials/dam_break.jl b/docs/literate/examples/dam_break.jl → docs/literate/tutorials/dam_break.jl
diff --git a/...erate/examples/implicit_jacobian_based.jl → ...rate/tutorials/implicit_jacobian_based.jl b/...erate/examples/implicit_jacobian_based.jl → ...rate/tutorials/implicit_jacobian_based.jl
diff --git a/...terate/examples/implicit_jacobian_free.jl → ...erate/tutorials/implicit_jacobian_free.jl b/...terate/examples/implicit_jacobian_free.jl → ...erate/tutorials/implicit_jacobian_free.jl
diff --git a/docs/literate/examples/rigid_body_contact.jl → .../literate/tutorials/rigid_body_contact.jl b/docs/literate/examples/rigid_body_contact.jl → .../literate/tutorials/rigid_body_contact.jl
diff --git a/docs/literate/examples/tlmpm_vortex.jl → docs/literate/tutorials/tlmpm_vortex.jl b/docs/literate/examples/tlmpm_vortex.jl → docs/literate/tutorials/tlmpm_vortex.jl
diff --git a/docs/make.jl b/docs/make.jl
@@ -18,16 +18,16 @@ makedocs(;
     sitename = "Tesserae.jl",
     pages=[
         "Home" => "index.md",
-        "getting_started.md",
-        "Examples" => [
-            "examples/collision.md",
+        "Tutorials" => [
+            "tutorials/getting_started.md",
+            "tutorials/collision.md",
             "Implicit methods" => [
-                "examples/implicit_jacobian_free.md",
-                "examples/implicit_jacobian_based.md",
+                "tutorials/implicit_jacobian_free.md",
+                "tutorials/implicit_jacobian_based.md",
             ],
-            "examples/dam_break.md",
-            "examples/tlmpm_vortex.md",
-            "examples/rigid_body_contact.md",
+            "tutorials/dam_break.md",
+            "tutorials/tlmpm_vortex.md",
+            "tutorials/rigid_body_contact.md",
         ],
     ],
     doctest = true, # :fix

diff --git a/docs/src/getting_started.md → docs/src/tutorials/getting_started.md b/docs/src/getting_started.md → docs/src/tutorials/getting_started.md