Skip to content

Commit

Permalink
Merge pull request #776 from JuliaReach/schillic/docs_blocks
Browse files Browse the repository at this point in the history 
Better blocks in docs/make.jl for quick commenting
  • Loading branch information
@schillic
schillic authored Feb 9, 2024
2 parents 0cfa58d + a7b4bf3 commit a20a870
Show file tree
Hide file tree
Showing 2 changed files with 118 additions and 53 deletions.
170 changes: 118 additions & 52 deletions docs/make.jl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ end
# ========================

SET_REPRESENTATIONS = ["Set representations" => [
#
#"Introduction" => "tutorials/set_representations/introduction.md",
#"Hyperrectangular sets" => "tutorials/set_representations/hyperrectangles.md",
"Zonotopic sets" => "tutorials/set_representations/zonotopes.md",
Expand All @@ -30,83 +31,125 @@ SET_REPRESENTATIONS = ["Set representations" => [
#"Other set operations" => "tutorials/set_representations/other_set_operations.md",
#"LazySets type hierarchy" => "tutorials/set_representations/lazysets_hierarchy.md",
#"Numerical tolerance" => "tutorials/set_representations/tolerance.md",
"Metric notions" => "tutorials/set_representations/distances.md"]]
"Metric notions" => "tutorials/set_representations/distances.md"
#
]]

LINEAR_METHODS = ["Linear methods" => ["Quickstart" => "tutorials/linear_methods/introduction.md",
LINEAR_METHODS = ["Linear methods" => [
#
"Introduction" => "tutorials/linear_methods/introduction.md",
"Discrete time reachability" => "tutorials/linear_methods/discrete_time.md",
"Dense time reachability" => "tutorials/linear_methods/dense_time.md",
#"Propagating zonotopes" => "tutorials/linear_methods/zonotopes_setprop.md",
#"Propagating hyperrectangles" => "tutorials/linear_methods/hyperrectangles_setprop.md",
#"Propagating support functions" => "tutorials/linear_methods/supfunc_setprop.md",
#"Helicopter model" => "generated_examples/Helicopter.md",
#"Helicopter model" => "tutorials/linear_methods/helicopter.md",
"Structural model" => "generated_examples/ISS.md"]]
"Structural model" => "generated_examples/ISS.md"
#
]]

UNCERTAIN_INPUTS = ["Modeling uncertain inputs" => [
#
#"Introduction" => "tutorials/uncertain_inputs/introduction.md",
"Building model" => "generated_examples/Building.md",
"Operational amplifier" => "generated_examples/OpAmp.md",
"Transmission line" => "generated_examples/TransmissionLine.md"]]

TAYLOR_METHODS = ["Taylor methods" => ["Introduction" => "tutorials/taylor_methods/introduction.md",
"Taylor model reach-sets" => "tutorials/taylor_methods/taylor_model_reachsets.md",
"Domain splitting" => "tutorials/taylor_methods/domain_splitting.md",
"Common gotchas" => "tutorials/taylor_methods/gotchas.md",
"Lotka-Volterra" => "generated_examples/LotkaVolterra.md",
"Van der Pol oscillator" => "generated_examples/VanDerPol.md",
"Lorenz system" => "generated_examples/Lorenz.md"]]
"Transmission line" => "generated_examples/TransmissionLine.md"
#
]]

TAYLOR_METHODS = ["Taylor methods" => [
#
"Introduction" => "tutorials/taylor_methods/introduction.md",
#"Taylor model reach-sets" => "tutorials/taylor_methods/taylor_model_reachsets.md",
"Domain splitting" => "tutorials/taylor_methods/domain_splitting.md",
"Common gotchas" => "tutorials/taylor_methods/gotchas.md",
"Lotka-Volterra" => "generated_examples/LotkaVolterra.md",
"Van der Pol oscillator" => "generated_examples/VanDerPol.md",
"Lorenz system" => "generated_examples/Lorenz.md"
#
]]

UNCERTAIN_PARAMETERS = ["Modeling uncertain parameters" => ["Introduction" => "tutorials/parametric_reachability/introduction.md"]]
# UNCERTAIN_PARAMETERS = ["Modeling uncertain parameters" => [
# #
# #"Introduction" => "tutorials/parametric_reachability/introduction.md"
# #
# ]]

HYBRID_SYSTEMS = ["Hybrid systems" => [
#
#"Introduction" => "tutorials/hybrid_systems/introduction.md",
#"Thermostat model" => "tutorials/hybrid_systems/thermostat.md",
"Square wave oscillator" => "generated_examples/SquareWaveOscillator.md"
#"Thermostat model" => "tutorials/hybrid_systems/thermostat.md"
#
]]

CLOCKED_SYSTEMS = ["Clocked systems" => [
#
#"Introduction" => "tutorials/clocked_systems/introduction.md",
"Platoon" => "generated_examples/Platoon.md",
"Electro-mechanic break" => "generated_examples/EMBrake.md"]]

BACKWARDS_REACHABILITY = ["Backwards reachability" => ["Introduction" => "tutorials/backwards_reachability/introduction.md",
"Projectile motion" => "generated_examples/Projectile.md"]]

LINEAR_PDE = ["Linear PDEs" => ["Introduction" => "tutorials/linear_pde/introduction.md",
"Clamped beam" => "tutorials/linear_pde/clamped.md",
"Heat transfer" => "tutorials/linear_pde/heat_transfer.md",
"Concrete heat of hydration" => "tutorials/linear_pde/concrete.md"]]
# "Clamped beam" => "examples/Clamped.md",
# "Heat transfer" => "examples/Heat1D.md",
# "Concrete heat of hydration" => "examples/Concrete.md"

LINEAR_SOLVERS = ["A20" => "man/algorithms/A20.md",
"Electro-mechanic break" => "generated_examples/EMBrake.md"
#
]]

BACKWARDS_REACHABILITY = ["Backwards reachability" => [
#
"Introduction" => "tutorials/backwards_reachability/introduction.md",
"Projectile motion" => "generated_examples/Projectile.md"
#
]]

# LINEAR_PDE = ["Linear PDEs" => [
# #
# "Introduction" => "tutorials/linear_pde/introduction.md",
# "Clamped beam" => "tutorials/linear_pde/clamped.md",
# "Heat transfer" => "tutorials/linear_pde/heat_transfer.md",
# "Concrete heat of hydration" => "tutorials/linear_pde/concrete.md"
# #
# ]]

LINEAR_SOLVERS = [
#
"A20" => "man/algorithms/A20.md",
"ASB07" => "man/algorithms/ASB07.md",
"BFFPSV18" => "man/algorithms/BFFPSV18.md",
"BOX" => "man/algorithms/BOX.md",
"GLGM06" => "man/algorithms/GLGM06.md",
"INT" => "man/algorithms/INT.md",
"LGG09" => "man/algorithms/LGG09.md",
"ORBIT" => "man/algorithms/ORBIT.md",
"VREP" => "man/algorithms/VREP.md"]
"VREP" => "man/algorithms/VREP.md"
#
]

LINEAR_SOLVERS_API = ["A20" => "lib/algorithms/A20.md",
LINEAR_SOLVERS_API = [
#
"A20" => "lib/algorithms/A20.md",
"ASB07" => "lib/algorithms/ASB07.md",
"BFFPSV18" => "lib/algorithms/BFFPSV18.md",
"BOX" => "lib/algorithms/BOX.md",
"GLGM06" => "lib/algorithms/GLGM06.md",
"INT" => "lib/algorithms/INT.md",
"LGG09" => "lib/algorithms/LGG09.md",
"ORBIT" => "lib/algorithms/ORBIT.md",
"VREP" => "lib/algorithms/VREP.md"]

NONLINEAR_SOLVERS = ["CARLIN" => "man/algorithms/CARLIN.md",
"QINT" => "man/algorithms/QINT.md",
"TMJets" => "man/algorithms/TMJets.md"]

NONLINEAR_SOLVERS_API = ["CARLIN" => "lib/algorithms/CARLIN.md",
"QINT" => "lib/algorithms/QINT.md",
"TMJets" => "lib/algorithms/TMJets.md"]
"VREP" => "lib/algorithms/VREP.md"
#
]

NONLINEAR_SOLVERS = [
#
"CARLIN" => "man/algorithms/CARLIN.md",
"QINT" => "man/algorithms/QINT.md",
"TMJets" => "man/algorithms/TMJets.md"
#
]

NONLINEAR_SOLVERS_API = [
#
"CARLIN" => "lib/algorithms/CARLIN.md",
"QINT" => "lib/algorithms/QINT.md",
"TMJets" => "lib/algorithms/TMJets.md"
#
]

# ========================
# Docs contents
Expand All @@ -120,16 +163,24 @@ makedocs(;
modules=[ReachabilityAnalysis],
doctest=false,
pagesonly=true,
pages=["Overview" => "index.md",
"Tutorials" => vcat(SET_REPRESENTATIONS,
pages=[
#
"Overview" => "index.md",
"Tutorials" => vcat(
#
SET_REPRESENTATIONS,
LINEAR_METHODS,
UNCERTAIN_INPUTS,
TAYLOR_METHODS,
#UNCERTAIN_PARAMETERS,
#LINEAR_PDE,
HYBRID_SYSTEMS,
CLOCKED_SYSTEMS),
"Manual" => ["Systems" => "man/systems.md",
CLOCKED_SYSTEMS
#
),
"Manual" => [
#
"Systems" => "man/systems.md",
#"Reach-sets" => "man/reachsets.md",
#"Flowpipes" => "man/flowpipes.md",
"Linear solvers" => LINEAR_SOLVERS
Expand All @@ -139,21 +190,32 @@ makedocs(;
#"Visualization" => "man/visualization.md",
#"Projections" => "man/projections.md",
#"Clustering" => "man/clustering.md"
#
],
"Benchmarks" => ["Repeatability evaluations" => "man/benchmarks/repeatability.md",
"Model library" => "man/benchmarks/model_library.md",
"Benchmarks" => [
#
"Repeatability evaluations" => "man/benchmarks/repeatability.md",
"Model library" => "man/benchmarks/model_library.md",
#"Comparison with other tools" => "man/benchmarks/comparison.md",
"Benchmark repository" => "man/benchmarks/benchmarks.md",
"Filtered oscillator" => "man/benchmarks/filtered_oscillator.md"],
"Further examples" => ["Overview" => "man/examples_overview.md",
"Filtered oscillator" => "man/benchmarks/filtered_oscillator.md"
#
],
"Further examples" => [
#
"Overview" => "man/examples_overview.md",
"Duffing oscillator" => "generated_examples/DuffingOscillator.md",
"Laub-Loomis" => "generated_examples/LaubLoomis.md",
"Production-Destruction" => "generated_examples/ProductionDestruction.md",
"Brusselator" => "generated_examples/Brusselator.md",
"Quadrotor" => "generated_examples/Quadrotor.md",
"Epidemic model" => "generated_examples/SEIR.md",
"Spacecraft" => "generated_examples/Spacecraft.md"],
"API Reference" => ["Systems" => "lib/systems.md",
"Spacecraft" => "generated_examples/Spacecraft.md"
#
],
"API Reference" => [
#
"Systems" => "lib/systems.md",
"Reach-sets" => "lib/reachsets.md",
"Flowpipes" => "lib/flowpipes.md",
"Linear solvers" => LINEAR_SOLVERS_API,
Expand All @@ -164,9 +226,13 @@ makedocs(;
"Clustering" => "lib/clustering.md",
"Further set operations" => "lib/operations.md",
"Distributed computations" => "lib/distributed.md",
"Internal functions and macros" => "lib/internals.md"],
"Internal functions and macros" => "lib/internals.md"
#
],
"Frequently Asked Questions (FAQ)" => "man/faq.md",
"Bibliography" => "references.md", "How to contribute" => "about.md"])
"Bibliography" => "references.md", "How to contribute" => "about.md"
#
])

# Deploy built documentation from Travis.
deploydocs(; repo="github.com/JuliaReach/ReachabilityAnalysis.jl.git",
Expand Down
1 change: 0 additions & 1 deletion docs/src/tutorials/linear_methods/helicopter.md
View file
Original file line number Diff line number Diff line change
@@ -1,2 +1 @@

# Helicopter model

0 comments on commit a20a870

Please sign in to comment.