Skip to content

Commit

Permalink
updates Documenter v1
Browse files Browse the repository at this point in the history
  • Loading branch information
baggepinnen committed Sep 22, 2023
1 parent 6e77cd5 commit 61480fd
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 9 deletions.
17 changes: 9 additions & 8 deletions docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,14 @@ makedocs(
sitename = "ControlSystemsMTK Documentation",
doctest = false,
modules = [ControlSystemsMTK, ControlSystemsBase, ModelingToolkit, ModelingToolkitStandardLibrary, RobustAndOptimalControl, SymbolicControlSystems],
strict=[
:doctest,
:linkcheck,
:parse_error,
:example_block,
# Other available options are
# :autodocs_block, :cross_references, :docs_block, :eval_block, :example_block, :footnote, :meta_block, :missing_docs, :setup_block
],
remotes = Dict(
dirname(dirname(pathof(ControlSystemsMTK))) => (Remotes.GitHub("JuliaControl", "ControlSystemsMTK.jl"), "1"),
dirname(dirname(pathof(ControlSystemsBase))) => (Remotes.GitHub("JuliaControl", "ControlSystems.jl"), "1"),
dirname(dirname(pathof(ModelingToolkit))) => (Remotes.GitHub("SciML", "ModelingToolkit.jl"), "8"),
dirname(dirname(pathof(ModelingToolkitStandardLibrary))) => (Remotes.GitHub("SciML", "ModelingToolkitStandardLibrary.jl"), "2"),
dirname(dirname(pathof(RobustAndOptimalControl))) => (Remotes.GitHub("JuliaControl", "RobustAndOptimalControl.jl"), "0.4"),
dirname(dirname(pathof(SymbolicControlSystems))) => (Remotes.GitHub("JuliaControl", "SymbolicControlSystems.jl"), "0.1"),
),
pages = [
"Home" => "index.md",
"Examples" => [
Expand All @@ -26,6 +26,7 @@ makedocs(
"API" => "api.md",
],
format = Documenter.HTML(prettyurls = haskey(ENV, "CI")),
warnonly = [:missing_docs, :docs_block, :cross_references],
)

deploydocs(
Expand Down
2 changes: 1 addition & 1 deletion docs/src/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,10 @@ linearize
linearization_function
loopshapingPID
named_ss
ModelingToolkit.linearize_symbolic
ModelingToolkitStandardLibrary.Blocks.get_looptransfer
ModelingToolkitStandardLibrary.Blocks.StateSpace
RobustAndOptimalControl.ss2particles
bodeplot
ControlSystemsBase.StateSpace
SymbolicControlSystems.ccode
SymbolicControlSystems.print_c_array
Expand Down

0 comments on commit 61480fd

Please sign in to comment.