Relecture

.github/workflows/CI.yml

@@ -10,3 +10,6 @@ on:
 jobs:
   call:
     uses: control-toolbox/CTActions/.github/workflows/ci.yml@main
+    with:
+      runners: '["ubuntu-latest"]'
+      versions: '["1.12"]'

.gitignore

@@ -33,3 +33,4 @@ Manifest.toml
 
 #
 .ipynb_checkpoints
+tmp/

docs/Project.toml

@@ -1,6 +1,7 @@
 [deps]
 Animations = "27a7e980-b3e6-11e9-2bcd-0b925532e340"
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
+LossControl = "6a3a0e7e-9c90-4c26-bc64-8dd630726a7b"
 NLPModelsIpopt = "f4238b75-b362-5c4c-b852-0801c9a21d71"
 NonlinearSolve = "8913a72c-1f9b-4ce2-8d82-65094dcecaec"
 OptimalControl = "5f98b655-cc9a-415a-b60e-744165666948"

docs/make.jl

@@ -1,6 +1,8 @@
 using Documenter
 
-# For reproducibility
+# ===============================================
+# --- Copy Project Assets for reproducibility ---
+# ===============================================
 mkpath(joinpath(@__DIR__, "src", "assets"))
 cp(
     joinpath(@__DIR__, "Manifest.toml"),
@@ -13,9 +15,21 @@ cp(
     force=true,
 )
 
+# Repository URL (used for links in docs)
 repo_url = "github.com/control-toolbox/LossControl.jl"
 
+# ==============================
+# --- Generate Documentation ---
+# ==============================
+# If draft is true, the Julia code in markdown is not executed.
+# To disable draft mode in a specific markdown file, add:
+#=
+```@meta
+Draft = false
+```
+=#
 makedocs(;
+    draft=false,
     warnonly=:cross_references,
     sitename="Loss control",
     format=Documenter.HTML(;
@@ -31,12 +45,17 @@ makedocs(;
     ),
     pages=[
         "Introduction" => "index.md",
-        "Statement of the problem" => "statement.md",
-        "Numerical approach" => "numerical.md",
-        "Zermelo navigation: Example 1" => "zermelo1.md",
-        "Zermelo navigation: Example 2" => "zermelo2.md",
-        "Harmonic oscillator problem" => "ho.md",
+        "Mathematical background" => [
+            "Optimal control and loss control" => "statement.md",
+            "Numerical approach" => "numerical.md",
+        ],
+        "Examples" => [
+            "Zermelo navigation: Example 1" => "zermelo1.md",
+            "Zermelo navigation: Example 2" => "zermelo2.md",
+            "Harmonic oscillator problem" => "ho.md",
+        ],
     ],
 )
 
-deploydocs(; repo=repo_url * ".git", devbranch="main")
+deploydocs(; repo=repo_url * ".git", devbranch="main", push_preview=true)
+# push_preview: use https://control-toolbox.org/LossControl.jl/previews/PRXXX where XXX is the pull request number