diff --git a/docs/src/index.md b/docs/src/index.md index fc30b36714..1820bb40d6 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -173,13 +173,16 @@ system: - Please refer to the [SciML ColPrac: Contributor's Guide on Collaborative Practices for Community Packages](https://github.com/SciML/ColPrac/blob/master/README.md) - for guidance on PRs, issues, and other matters relating to contributing to ModelingToolkit. + for guidance on PRs, issues, and other matters relating to contributing to SciML. + - See the [SciML Style Guide](https://github.com/SciML/SciMLStyle) for common coding practices and other style decisions. - There are a few community forums: - + The #diffeq-bridged channel in the [Julia Slack](https://julialang.org/slack/) - + [JuliaDiffEq](https://gitter.im/JuliaDiffEq/Lobby) on Gitter - + On the Julia Discourse forums (look for the [modelingtoolkit tag](https://discourse.julialang.org/tag/modelingtoolkit)) + + The #diffeq-bridged and #sciml-bridged channels in the + [Julia Slack](https://julialang.org/slack/) + + The #diffeq-bridged and #sciml-bridged channels in the + [Julia Zulip](https://julialang.zulipchat.com/#narrow/stream/279055-sciml-bridged) + + On the [Julia Discourse forums](https://discourse.julialang.org) + See also [SciML Community page](https://sciml.ai/community/) ## Reproducibility diff --git a/docs/src/systems/DiscreteSystem.md b/docs/src/systems/DiscreteSystem.md index c9d4b81c48..d9934d5fb7 100644 --- a/docs/src/systems/DiscreteSystem.md +++ b/docs/src/systems/DiscreteSystem.md @@ -23,7 +23,7 @@ DiscreteSystem ```@docs DiscreteFunction(sys::ModelingToolkit.DiscreteSystem, args...) -DiscreteProblem(sys::ModelingToolkit.DiscreteSystem, args...) +DiscreteProblem(sys::ModelingToolkit.DiscreteSystem, u0map, tspan) ``` ## Expression Constructors diff --git a/docs/src/systems/JumpSystem.md b/docs/src/systems/JumpSystem.md index 3dbeb8500d..68f0de2a5c 100644 --- a/docs/src/systems/JumpSystem.md +++ b/docs/src/systems/JumpSystem.md @@ -15,7 +15,7 @@ JumpSystem ## Transformations -```@docs +```@docs; canonical=false structural_simplify ``` @@ -23,7 +23,9 @@ structural_simplify ## Problem Constructors +```@docs; canonical=false +DiscreteProblem(sys::ModelingToolkit.DiscreteSystem, u0map, tspan) +``` ```@docs -SciMLBase.DiscreteProblem(sys::JumpSystem,args...) -JumpProcesses.JumpProblem(sys::JumpSystem,args...) +JumpProblem(sys::JumpSystem, prob, aggregator) ``` diff --git a/docs/src/systems/NonlinearSystem.md b/docs/src/systems/NonlinearSystem.md index d14e6a035c..dfdb8db508 100644 --- a/docs/src/systems/NonlinearSystem.md +++ b/docs/src/systems/NonlinearSystem.md @@ -15,7 +15,7 @@ NonlinearSystem ## Transformations -```@docs +```@docs; canonical=false structural_simplify alias_elimination tearing @@ -23,14 +23,14 @@ tearing ## Analyses -```@docs +```@docs; canonical=false ModelingToolkit.isaffine ModelingToolkit.islinear ``` ## Applicable Calculation and Generation Functions -```julia +```@docs; canonical=false calculate_jacobian generate_jacobian jacobian_sparsity diff --git a/docs/src/systems/ODESystem.md b/docs/src/systems/ODESystem.md index 207ab098e7..f79263436f 100644 --- a/docs/src/systems/ODESystem.md +++ b/docs/src/systems/ODESystem.md @@ -35,7 +35,7 @@ ModelingToolkit.isaffine ## Applicable Calculation and Generation Functions -```julia +```@docs; canonical=false calculate_jacobian calculate_tgrad calculate_factorized_W @@ -56,7 +56,7 @@ SteadyStateProblem(sys::ModelingToolkit.AbstractODESystem, args...) ## Torn Problem Constructors ```@docs -ODAEProblem(sys::ModelingToolkit.AbstractODESystem, args...) +ODAEProblem ``` ## Expression Constructors diff --git a/docs/src/systems/SDESystem.md b/docs/src/systems/SDESystem.md index 57b89b304a..17f062c5ae 100644 --- a/docs/src/systems/SDESystem.md +++ b/docs/src/systems/SDESystem.md @@ -22,17 +22,19 @@ sde = SDESystem(ode, noiseeqs) ## Transformations -```@docs +```@docs; canonical=false structural_simplify alias_elimination -Girsanov_transform +``` +```@docs +ModelingToolkit.Girsanov_transform ``` ## Analyses ## Applicable Calculation and Generation Functions -```julia +```@docs; canonical=false calculate_jacobian calculate_tgrad calculate_factorized_W