From 0cd03e0af900481615abea2dcf4cb5b6ebe6a401 Mon Sep 17 00:00:00 2001 From: ArnoStrouwen Date: Sat, 24 Aug 2024 17:31:33 +0200 Subject: [PATCH] collapse docstrings by default --- docs/src/explicit/AdamsBashforthMoulton.md | 3 +++ docs/src/explicit/Extrapolation.md | 3 +++ docs/src/explicit/Feagin.md | 3 +++ docs/src/explicit/HighOrderRK.md | 3 +++ docs/src/explicit/LowOrderRK.md | 3 +++ docs/src/explicit/LowStorageRK.md | 3 +++ docs/src/explicit/Nordsieck.md | 3 +++ docs/src/explicit/PRK.md | 3 +++ docs/src/explicit/QPRK.md | 3 +++ docs/src/explicit/RKN.md | 3 +++ docs/src/explicit/SSPRK.md | 3 +++ docs/src/explicit/SymplecticRK.md | 3 +++ docs/src/explicit/Tsit5.md | 3 +++ docs/src/explicit/Verner.md | 3 +++ docs/src/imex/IMEXMultistep.md | 3 +++ docs/src/implicit/BDF.md | 3 +++ docs/src/implicit/Extrapolation.md | 3 +++ docs/src/implicit/FIRK.md | 3 +++ docs/src/implicit/PDIRK.md | 3 +++ docs/src/implicit/Rosenbrock.md | 4 ++++ docs/src/implicit/SDIRK.md | 3 +++ docs/src/implicit/StabalizedIRK.md | 3 +++ docs/src/implicit/StabalizedRK.md | 3 +++ docs/src/semilinear/ExponentialRK.md | 3 +++ docs/src/semilinear/Linear.md | 3 +++ 25 files changed, 76 insertions(+) diff --git a/docs/src/explicit/AdamsBashforthMoulton.md b/docs/src/explicit/AdamsBashforthMoulton.md index f1e6638cfc..ec9b392aab 100644 --- a/docs/src/explicit/AdamsBashforthMoulton.md +++ b/docs/src/explicit/AdamsBashforthMoulton.md @@ -1,3 +1,6 @@ +```@meta +CollapsedDocStrings = true +``` # OrdinaryDiffEqAdamsBashforthMoulton Multistep methods, useful for integrating a very expensive to evaluate non-stiff system of differential equations. diff --git a/docs/src/explicit/Extrapolation.md b/docs/src/explicit/Extrapolation.md index da5af6308e..892a99e60f 100644 --- a/docs/src/explicit/Extrapolation.md +++ b/docs/src/explicit/Extrapolation.md @@ -1,3 +1,6 @@ +```@meta +CollapsedDocStrings = true +``` # OrdinaryDiffEqExtrapolation Solvers based on within method parallelism. diff --git a/docs/src/explicit/Feagin.md b/docs/src/explicit/Feagin.md index 5790939f17..13fc1b4cad 100644 --- a/docs/src/explicit/Feagin.md +++ b/docs/src/explicit/Feagin.md @@ -1,3 +1,6 @@ +```@meta +CollapsedDocStrings = true +``` # OrdinaryDiffEqFeagin Preferred solvers for non-stiff problems at very low tolerance, `<1e-30`. diff --git a/docs/src/explicit/HighOrderRK.md b/docs/src/explicit/HighOrderRK.md index e509405580..0401afd5ce 100644 --- a/docs/src/explicit/HighOrderRK.md +++ b/docs/src/explicit/HighOrderRK.md @@ -1,3 +1,6 @@ +```@meta +CollapsedDocStrings = true +``` # OrdinaryDiffEqHighOrderRK Solvers for non-stiff problems at low tolerance. diff --git a/docs/src/explicit/LowOrderRK.md b/docs/src/explicit/LowOrderRK.md index 39d48a1438..0e6041773e 100644 --- a/docs/src/explicit/LowOrderRK.md +++ b/docs/src/explicit/LowOrderRK.md @@ -1,3 +1,6 @@ +```@meta +CollapsedDocStrings = true +``` # OrdinaryDiffEqLowOrderRK If [`OrdinaryDiffEqTsit5`](@ref OrdinaryDiffEqTsit5) is not working well for your non-stiff problem at default and higher tolerance, diff --git a/docs/src/explicit/LowStorageRK.md b/docs/src/explicit/LowStorageRK.md index 3bd22b9941..127f6fbb8a 100644 --- a/docs/src/explicit/LowStorageRK.md +++ b/docs/src/explicit/LowStorageRK.md @@ -1,3 +1,6 @@ +```@meta +CollapsedDocStrings = true +``` # OrdinaryDiffEqLowStorageRK These methods are designed to have reduced register requirements, allowing for larger sets of ODEs to more diff --git a/docs/src/explicit/Nordsieck.md b/docs/src/explicit/Nordsieck.md index 042c12ab83..12d571bc47 100644 --- a/docs/src/explicit/Nordsieck.md +++ b/docs/src/explicit/Nordsieck.md @@ -1,3 +1,6 @@ +```@meta +CollapsedDocStrings = true +``` # OrdinaryDiffEqNordsieck The Nordsieck form is an alternative representation of multistep methods which, diff --git a/docs/src/explicit/PRK.md b/docs/src/explicit/PRK.md index 13e1406ed6..6e28579d67 100644 --- a/docs/src/explicit/PRK.md +++ b/docs/src/explicit/PRK.md @@ -1,3 +1,6 @@ +```@meta +CollapsedDocStrings = true +``` # OrdinaryDiffEqPRK Explicit solvers optimized for a certain number of parallel calls of the system of ordinary differential equations `f`. diff --git a/docs/src/explicit/QPRK.md b/docs/src/explicit/QPRK.md index 2251baa961..937ee6fc4c 100644 --- a/docs/src/explicit/QPRK.md +++ b/docs/src/explicit/QPRK.md @@ -1,3 +1,6 @@ +```@meta +CollapsedDocStrings = true +``` # OrdinaryDiffEqQPRK Explicit solvers optimized for a certain number of parallel calls of the system of ordinary differential equations `f`. diff --git a/docs/src/explicit/RKN.md b/docs/src/explicit/RKN.md index ea5bc9ed60..e2f297e93d 100644 --- a/docs/src/explicit/RKN.md +++ b/docs/src/explicit/RKN.md @@ -1,3 +1,6 @@ +```@meta +CollapsedDocStrings = true +``` # OrdinaryDiffEqRKN Second order solvers. diff --git a/docs/src/explicit/SSPRK.md b/docs/src/explicit/SSPRK.md index e5f52c55d1..de235d181f 100644 --- a/docs/src/explicit/SSPRK.md +++ b/docs/src/explicit/SSPRK.md @@ -1,3 +1,6 @@ +```@meta +CollapsedDocStrings = true +``` # OrdinaryDiffEqSSPRK SSPRK methods are Runge-Kutta methods which support the "strongly preserving property" (SSP). diff --git a/docs/src/explicit/SymplecticRK.md b/docs/src/explicit/SymplecticRK.md index f5556da346..2bf5913910 100644 --- a/docs/src/explicit/SymplecticRK.md +++ b/docs/src/explicit/SymplecticRK.md @@ -1,3 +1,6 @@ +```@meta +CollapsedDocStrings = true +``` # OrdinaryDiffEqSymplecticRK A symplectic integrator is an integrator whose solution resides on a symplectic manifold. diff --git a/docs/src/explicit/Tsit5.md b/docs/src/explicit/Tsit5.md index 9494c4e118..8971b1e72f 100644 --- a/docs/src/explicit/Tsit5.md +++ b/docs/src/explicit/Tsit5.md @@ -1,3 +1,6 @@ +```@meta +CollapsedDocStrings = true +``` # [OrdinaryDiffEqTsit5](@id OrdinaryDiffEqTsit5) Recommended solver for most non-stiff problems at default and higher tolerance. diff --git a/docs/src/explicit/Verner.md b/docs/src/explicit/Verner.md index 21425524be..083f737163 100644 --- a/docs/src/explicit/Verner.md +++ b/docs/src/explicit/Verner.md @@ -1,3 +1,6 @@ +```@meta +CollapsedDocStrings = true +``` # [OrdinaryDiffEqVerner](@id OrdinaryDiffEqVerner) Preferred solvers for non-stiff problems at low tolerance. diff --git a/docs/src/imex/IMEXMultistep.md b/docs/src/imex/IMEXMultistep.md index d8e5a30f01..c844278c16 100644 --- a/docs/src/imex/IMEXMultistep.md +++ b/docs/src/imex/IMEXMultistep.md @@ -1,3 +1,6 @@ +```@meta +CollapsedDocStrings = true +``` # OrdinaryDiffEqIMEXMultistep Solvers if your system of ordinary differential equations can be split up into the sum of a stiff and non-stiff part. diff --git a/docs/src/implicit/BDF.md b/docs/src/implicit/BDF.md index 7079b6156f..ac223b4a85 100644 --- a/docs/src/implicit/BDF.md +++ b/docs/src/implicit/BDF.md @@ -1,3 +1,6 @@ +```@meta +CollapsedDocStrings = true +``` # OrdinaryDiffEqBDF Multistep methods, good for large stiff systems. diff --git a/docs/src/implicit/Extrapolation.md b/docs/src/implicit/Extrapolation.md index a909fd3b57..3ed339d39a 100644 --- a/docs/src/implicit/Extrapolation.md +++ b/docs/src/implicit/Extrapolation.md @@ -1,3 +1,6 @@ +```@meta +CollapsedDocStrings = true +``` # [OrdinaryDiffEqExtrapolation](@id StiffExtrapolation) Solvers based on within method parallelism. diff --git a/docs/src/implicit/FIRK.md b/docs/src/implicit/FIRK.md index c8d8a2d7fb..44fe2461b0 100644 --- a/docs/src/implicit/FIRK.md +++ b/docs/src/implicit/FIRK.md @@ -1,3 +1,6 @@ +```@meta +CollapsedDocStrings = true +``` # OrdinaryDiffEqFIRK FIRK methods are fully implicit Runge-Kutta methods. diff --git a/docs/src/implicit/PDIRK.md b/docs/src/implicit/PDIRK.md index dba01b2405..7edc74a0e5 100644 --- a/docs/src/implicit/PDIRK.md +++ b/docs/src/implicit/PDIRK.md @@ -1,3 +1,6 @@ +```@meta +CollapsedDocStrings = true +``` # OrdinaryDiffEqPDIRK PDIRK methods are parallel DIRK methods. diff --git a/docs/src/implicit/Rosenbrock.md b/docs/src/implicit/Rosenbrock.md index 7c5e8b6646..fc9087a408 100644 --- a/docs/src/implicit/Rosenbrock.md +++ b/docs/src/implicit/Rosenbrock.md @@ -1,3 +1,7 @@ + +```@meta +CollapsedDocStrings = true +``` # OrdinaryDiffEqRosenbrock Methods for small and medium sized stiff systems of differential equations. diff --git a/docs/src/implicit/SDIRK.md b/docs/src/implicit/SDIRK.md index 478b306f07..204c91a7f5 100644 --- a/docs/src/implicit/SDIRK.md +++ b/docs/src/implicit/SDIRK.md @@ -1,3 +1,6 @@ +```@meta +CollapsedDocStrings = true +``` # OrdinaryDiffEqSDIRK This article is a stub. diff --git a/docs/src/implicit/StabalizedIRK.md b/docs/src/implicit/StabalizedIRK.md index 25e4aaca1f..f956ff1aa1 100644 --- a/docs/src/implicit/StabalizedIRK.md +++ b/docs/src/implicit/StabalizedIRK.md @@ -1,3 +1,6 @@ +```@meta +CollapsedDocStrings = true +``` # OrdinaryDiffEqStabalizedIRK Stabilized Explicit Runge-Kutta methods, diff --git a/docs/src/implicit/StabalizedRK.md b/docs/src/implicit/StabalizedRK.md index d1e62c1137..2e20b12479 100644 --- a/docs/src/implicit/StabalizedRK.md +++ b/docs/src/implicit/StabalizedRK.md @@ -1,3 +1,6 @@ +```@meta +CollapsedDocStrings = true +``` # OrdinaryDiffEqStabalizedRK Explicit stabilized methods utilize an upper bound on the spectral radius of the Jacobian. diff --git a/docs/src/semilinear/ExponentialRK.md b/docs/src/semilinear/ExponentialRK.md index 9e0b5aabc9..fed72b79be 100644 --- a/docs/src/semilinear/ExponentialRK.md +++ b/docs/src/semilinear/ExponentialRK.md @@ -1,3 +1,6 @@ +```@meta +CollapsedDocStrings = true +``` # OrdinaryDiffEqExponentialRK Methods for semi-linear differential equations. diff --git a/docs/src/semilinear/Linear.md b/docs/src/semilinear/Linear.md index b17d4366a4..149c2f99f5 100644 --- a/docs/src/semilinear/Linear.md +++ b/docs/src/semilinear/Linear.md @@ -1,3 +1,6 @@ +```@meta +CollapsedDocStrings = true +``` # OrdinaryDiffEqLinear Methods for semi-linear differential equations.