collapse docstrings by default

SciML · Aug 25, 2024 · 0cd03e0 · 0cd03e0
1 parent 1f08cee
commit 0cd03e0
Show file tree

Hide file tree

Showing 25 changed files with 76 additions and 0 deletions.
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -1,3 +1,6 @@
+```@meta
+CollapsedDocStrings = true
+```
 # OrdinaryDiffEqLinear
 
 Methods for semi-linear differential equations.