diff --git a/docs/make.jl b/docs/make.jl index e4829e07..44477b0f 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -11,6 +11,10 @@ using ModelingToolkit using OrdinaryDiffEqTsit5 using SteadyStateDiffEq +TimeEvolution = Base.get_extension(HarmonicBalance, :TimeEvolution) +ModelingToolkitExt = Base.get_extension(HarmonicBalance, :ModelingToolkitExt) +SteadyStateDiffEqExt = Base.get_extension(HarmonicBalance, :SteadyStateDiffEqExt) + bib = CitationBibliography( joinpath(@__DIR__, "src", "refs.bib"); style=:numeric, # default @@ -32,9 +36,9 @@ makedocs(; authors="Quest group", modules=[ HarmonicBalance, - Base.get_extension(HarmonicBalance, :TimeEvolution), - Base.get_extension(HarmonicBalance, :ModelingToolkitExt), - Base.get_extension(HarmonicBalance, :SteadyStateDiffEqExt), + TimeEvolution, + ModelingToolkitExt, + SteadyStateDiffEqExt, HarmonicBalance.LinearResponse, ], format=DocumenterVitepress.MarkdownVitepress(; @@ -47,7 +51,11 @@ makedocs(; source="src", build="build", draft=!CI, - warnonly=[:linkcheck, :cross_references], + warnonly=if CI + [:linkcheck, :cross_references] + else + [:linkcheck, :cross_references, :missing_docs,:docs_block] + end, doctest=false, # We test it in the CI, no need to run it here plugins=[bib], ) diff --git a/docs/src/manual/API.md b/docs/src/manual/API.md index fe81c0f8..46d9f7f0 100644 --- a/docs/src/manual/API.md +++ b/docs/src/manual/API.md @@ -89,7 +89,6 @@ Order = [:function] get_Jacobian ``` - ## Extensions ### OrdinaryDiffEq @@ -112,20 +111,11 @@ Order = [:function] steady_state_sweep ``` -```@autodocs; canonical=false -Modules = [Base.get_extension(HarmonicBalance, :SteadyStateDiffEqExt)] -Private = false -Order = [:function] -``` - ### ModelingToolkit ```@docs ODEProblem -``` - -```@autodocs; canonical=false -Modules = [Base.get_extension(HarmonicBalance, :ModelingToolkitExt)] -Private = false -Order = [:function] +ModelingToolkit.ODESystem +ModelingToolkit.SciMLBase.SteadyStateProblem +ModelingToolkit.SciMLBase.NonlinearProblem ``` diff --git a/ext/ModelingToolkitExt.jl b/ext/ModelingToolkitExt.jl index 47857fb8..0cfe2542 100644 --- a/ext/ModelingToolkitExt.jl +++ b/ext/ModelingToolkitExt.jl @@ -36,7 +36,7 @@ function declare_parameter(var::Num) return eval(var_sym) end -""" +@doc """ $(TYPEDSIGNATURES) Creates and ModelingToolkit.ODESystem from a HarmonicEquation. @@ -66,7 +66,7 @@ function ModelingToolkit.ODESystem(eom::HarmonicEquation) return sys end -""" +@doc """ $(TYPEDSIGNATURES) Creates and ModelingToolkit.ODESystem from a DifferentialEquation. @@ -97,7 +97,7 @@ function ModelingToolkit.ODESystem(diff_eq::DifferentialEquation) return sys end -""" +@doc """ $(TYPEDSIGNATURES) Creates and ModelingToolkit.ODEProblem from a DifferentialEquation. @@ -120,7 +120,7 @@ function ModelingToolkit.ODEProblem( return prob end -""" +@doc """ $(TYPEDSIGNATURES) Creates and ModelingToolkit.NonlinearProblem from a DifferentialEquation. @@ -132,7 +132,7 @@ function ModelingToolkit.NonlinearProblem( return NonlinearProblem(ss_prob) end -""" +@doc """ $(TYPEDSIGNATURES) Creates and ModelingToolkit.SteadyStateProblem from a DifferentialEquation.