From 66f7b68dabe25e4d1e2376e74849a3f570c6151b Mon Sep 17 00:00:00 2001 From: Simon Exner Date: Fri, 29 Sep 2023 10:27:09 +0200 Subject: [PATCH] doc fixes --- .gitignore | 14 ++++++++++++++ docs/make.jl | 2 +- src/FMI.jl | 2 +- 3 files changed, 16 insertions(+), 2 deletions(-) diff --git a/.gitignore b/.gitignore index 398528dd..a1db039a 100644 --- a/.gitignore +++ b/.gitignore @@ -29,3 +29,17 @@ LocalPreferences.toml tmp/ .vscode/settings.json examples/src/.ipynb_checkpoints/ +docs/src/examples/manipulation.md +docs/src/examples/manipulation_files/ +docs/src/examples/modelica_conference_2021.md +docs/src/examples/modelica_conference_2021_files/ +docs/src/examples/multiple_instances.md +docs/src/examples/multiple_instances_files/ +docs/src/examples/multiprocessing.md +docs/src/examples/multithreading.md +docs/src/examples/parameter_optimization.md +docs/src/examples/parameter_optimization_files/ +docs/src/examples/parameterize.md +docs/src/examples/simulate.md +docs/src/examples/simulate_files/ +docs/src/index.md diff --git a/docs/make.jl b/docs/make.jl index dafa3475..7e71a28f 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -7,13 +7,13 @@ using Documenter, FMI, Plots, FMIImport using Documenter: GitHubActions makedocs(sitename="FMI.jl", - #modules = [FMI,FMIImport], format = Documenter.HTML( collapselevel = 1, sidebar_sitename = false, edit_link = nothing, size_threshold_ignore = ["fmi2_library.md"] ), + warnonly=true, pages= Any[ "Introduction" => "index.md" "Features" => "features.md" diff --git a/src/FMI.jl b/src/FMI.jl index 9bc75f6d..1cb63135 100644 --- a/src/FMI.jl +++ b/src/FMI.jl @@ -1052,13 +1052,13 @@ More detailed: `fmi3Struct = Union{FMU3, FMU3Instance}` See also [`fmi2SimulateME`](@ref) [`fmi2SimulateCS`](@ref), [`fmi2Simulate`](@ref), [`fmi2Struct`](@ref), [`FMU2`](@ref), [`FMU2Component`](@ref). """ - function fmiSimulateME(str::fmi2Struct, tspan::Union{Tuple{Float64, Float64}, Nothing}=nothing, args...; kwargs...) fmi2SimulateME(str, tspan, args...; kwargs...) end function fmiSimulateME(str::fmi3Struct, args...; kwargs...) fmi3SimulateME(str, args...; kwargs...) end + """ fmiUnload(fmu::Union{FMU2, FMU3})