Merge pull request #62 from control-toolbox/v2

Tutorials with OptimalControl v2

Author: ocots

Project.toml

@@ -1,7 +1,7 @@
 name = "Tutorials"
 uuid = "cb10daa6-a5e5-4c25-a171-ae181b8ea3c9"
 authors = ["Olivier Cots <olivier.cots@toulouse-inp.fr>"]
-version = "0.3.2"
+version = "0.4.0"
 
 [compat]
 julia = "1.10"

docs/Project.toml

@@ -26,11 +26,11 @@ DocumenterInterLinks = "1"
 ForwardDiff = "0.10, 1"
 LinearAlgebra = "1"
 MINPACK = "1"
-MadNLP = "0.8"
+MadNLP = "0.9"
 NLPModels = "0.21"
 NLPModelsIpopt = "0.11"
 NonlinearSolve = "4"
-OptimalControl = "1"
+OptimalControl = "2"
 OrdinaryDiffEq = "6"
 Plots = "1"
 Printf = "1"

docs/make.jl

@@ -1,3 +1,8 @@
+# to run the documentation generation:
+# julia --project=. docs/make.jl
+pushfirst!(LOAD_PATH, joinpath(@__DIR__, ".."))
+pushfirst!(LOAD_PATH, @__DIR__)
+
 using Documenter
 using DocumenterInterLinks
 using OptimalControl
@@ -16,7 +21,9 @@ links = InterLinks(
     ),
 )
 
-# For reproducibility
+# ═══════════════════════════════════════════════════════════════════════════════
+# Assets for reproducibility
+# ═══════════════════════════════════════════════════════════════════════════════
 mkpath(joinpath(@__DIR__, "src", "assets"))
 cp(
     joinpath(@__DIR__, "Manifest.toml"),
@@ -31,21 +38,32 @@ cp(
 
 repo_url = "github.com/control-toolbox/Tutorials.jl"
 
-# if draft is true, then the julia code from .md is not executed # debug
+# ═══════════════════════════════════════════════════════════════════════════════
+# Configuration
+# ═══════════════════════════════════════════════════════════════════════════════
+# if draft is true, then the julia code from .md is not executed
 # to disable the draft mode in a specific markdown file, use the following:
 #=
 ```@meta
 Draft = false
 ```
 =#
+draft = false  # Draft mode: if true, @example blocks in markdown are not executed
+
+# ═══════════════════════════════════════════════════════════════════════════════
+# Build documentation
+# ═══════════════════════════════════════════════════════════════════════════════
 makedocs(;
-    draft=false,
-    warnonly=[:cross_references, :autodocs_block],
+    draft=draft,
+    warnonly=[:cross_references, :autodocs_block, :external_cross_references],
     sitename="Tutorials",
     format=Documenter.HTML(;
         repolink="https://" * repo_url,
         prettyurls=false,
-        size_threshold_ignore=[""],
+        size_threshold_ignore=[
+            "tutorial-discretisation.md",
+            "tutorial-nlp.md",
+        ],
         assets=[
             asset("https://control-toolbox.org/assets/css/documentation.css"),
             asset("https://control-toolbox.org/assets/js/documentation.js"),