diff --git a/.github/workflows/Example.yml b/.github/workflows/Example.yml index 1c9a88c4..f2097c31 100644 --- a/.github/workflows/Example.yml +++ b/.github/workflows/Example.yml @@ -86,7 +86,7 @@ jobs: runs-on: ubuntu-latest steps: - name: "Check out repository" - uses: actions/checkout@v3 + uses: actions/checkout@v4 - name: "Set up Julia" uses: julia-actions/setup-julia@v1 diff --git a/README.md b/README.md index d27f4eb8..faf45024 100644 --- a/README.md +++ b/README.md @@ -6,12 +6,12 @@ | | | |---|---| -| Documentation | [![Build Docs](https://github.com/ThummeTo/FMI.jl/actions/workflows/Documentation.yml/badge.svg)](https://github.com/ThummeTo/FMI.jl/actions/workflows/Documentation.yml) [![Dev Docs](https://img.shields.io/badge/docs-dev-blue.svg)](https://ThummeTo.github.io/FMI.jl/dev) | +| Documentation | [![Build Docs](https://github.com/ThummeTo/FMI.jl/actions/workflows/Documentation.yml/badge.svg)](https://github.com/ThummeTo/FMI.jl/actions/workflows/Documentation.yml) [![Dev Docs](https://img.shields.io/badge/docs-dev-blue.svg)](https://thummeto.github.io/FMI.jl/dev/) | | Examples | [![Examples (latest)](https://github.com/ThummeTo/FMI.jl/actions/workflows/Example.yml/badge.svg)](https://github.com/ThummeTo/FMI.jl/actions/workflows/Example.yml) | | Tests | [![Test (latest)](https://github.com/ThummeTo/FMI.jl/actions/workflows/TestLatest.yml/badge.svg)](https://github.com/ThummeTo/FMI.jl/actions/workflows/TestLatest.yml) [![Test (LTS)](https://github.com/ThummeTo/FMI.jl/actions/workflows/TestLTS.yml/badge.svg)](https://github.com/ThummeTo/FMI.jl/actions/workflows/TestLTS.yml) [![Aqua QA](https://raw.githubusercontent.com/JuliaTesting/Aqua.jl/master/badge.svg)](https://github.com/JuliaTesting/Aqua.jl) | | FMI cross checks| [![FMI2 Cross Checks](https://github.com/ThummeTo/FMI.jl/actions/workflows/CrossChecks.yml/badge.svg)](https://github.com/ThummeTo/FMI.jl/actions/workflows/CrossChecks.yml) | | Package evaluation| [![Run PkgEval](https://github.com/ThummeTo/FMI.jl/actions/workflows/Eval.yml/badge.svg)](https://github.com/ThummeTo/FMI.jl/actions/workflows/Eval.yml) | -| Code coverage | [![Coverage](https://codecov.io/gh/ThummeTo/FMI.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/ThummeTo/FMI.jl) | +| Code coverage | [![Coverage](https://codecov.io/gh/ThummeTo/FMI.jl/branch/main/graph/badge.svg)](https://app.codecov.io/gh/ThummeTo/FMI.jl) | | Collaboration | [![ColPrac: Contributor's Guide on Collaborative Practices for Community Packages](https://img.shields.io/badge/ColPrac-Contributor's%20Guide-blueviolet)](https://github.com/SciML/ColPrac) | | Formatting | [![SciML Code Style](https://img.shields.io/static/v1?label=code%20style&message=SciML&color=9558b2&labelColor=389826)](https://github.com/SciML/SciMLStyle) | diff --git a/docs/Project.toml b/docs/Project.toml index 212806db..90fc4824 100644 --- a/docs/Project.toml +++ b/docs/Project.toml @@ -9,6 +9,7 @@ JLD2 = "033835bb-8acc-5ee8-8aae-3f567f8a3819" JuliaFormatter = "98e50ef6-434e-11e9-1051-2b60c6c9e899" MAT = "23992714-dd62-5051-b70f-ba57cb901cac" Plots = "91a5bcdd-55d7-5caf-9e0b-520d859cae80" +Suppressor = "fd094767-a336-5f1f-9728-57cf17d0bbfb" [compat] julia = "1.6" diff --git a/docs/make.jl b/docs/make.jl index 6bd147ae..bec5e3c5 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -7,6 +7,7 @@ import Pkg; Pkg.develop(path = joinpath(@__DIR__, "../../FMI.jl")); using Documenter, Plots, JLD2, DataFrames, CSV, MAT, FMI, FMIBase, FMIImport, FMICore using Documenter: GitHubActions +using Suppressor example_pages = [ "Overview" => "examples/overview.md", @@ -21,18 +22,23 @@ example_pages = [ "Pluto Workshops" => "examples/workshops.md", ] -makedocs( +my_makedocs() = makedocs( sitename = "FMI.jl", format = Documenter.HTML( collapselevel = 1, sidebar_sitename = false, edit_link = nothing, size_threshold = 512000, - size_threshold_ignore = ["deprecated.md"], + size_threshold_ignore = [ + "deprecated.md", + "fmi2_lowlevel_library_functions.md", + "fmi3_lowlevel_library_functions.md", + ], ), modules = [FMI, FMIImport, FMICore, FMIBase], checkdocs = :exports, linkcheck = true, + warnonly = :linkcheck, pages = Any[ "Introduction" => "index.md" "Features" => "features.md" @@ -83,6 +89,23 @@ function deployConfig() return GitHubActions(github_repository, github_event_name, github_ref) end +output = "" +try + global output = @capture_err begin + my_makedocs() + end +catch e + my_makedocs() # if it fails, re-run without capturing, so that its stderr appears in the console/logs +end + +# errors = findall(r"Error:.*", output) +warns = findall(r"Warning:.*", output) + +for w in warns + s = string("::warning title=Documenter-Warning::", output[w], "\r\n") + print(s) +end + deploydocs( repo = "github.com/ThummeTo/FMI.jl.git", devbranch = "main", diff --git a/docs/src/fmi2_lowlevel_library_functions.md b/docs/src/fmi2_lowlevel_library_functions.md index a64b1981..1f16a5a8 100644 --- a/docs/src/fmi2_lowlevel_library_functions.md +++ b/docs/src/fmi2_lowlevel_library_functions.md @@ -87,23 +87,6 @@ fmi2GetRealOutputDerivatives! fmi2SampleJacobian fmi2SampleJacobian! -## Conversion functions - -```@docs -fmi2StringToValueReference -fmi2ValueReferenceToString -fmi2StringToCausality -fmi2CausalityToString -fmi2StringToVariability -fmi2VariabilityToString - -fmi2StatusToString -fmi2StringToDependencyKind -fmi2DependencyKindToString -fmi2StringToInitial -fmi2InitialToString -``` - ## External/Additional functions ```@docs diff --git a/docs/src/fmi3_lowlevel_library_functions.md b/docs/src/fmi3_lowlevel_library_functions.md index ff2e9f69..d109fdeb 100644 --- a/docs/src/fmi3_lowlevel_library_functions.md +++ b/docs/src/fmi3_lowlevel_library_functions.md @@ -2,15 +2,6 @@ In both cases, FMI defines an input/output block of a dynamic model where the distribution of the block, the platform dependent header file, several access functions, as well as the schema files are identical. -## Opening and closing FMUs - -```@docs -``` -fmi3Unzip -fmi3Load -fmi3Reload -fmi3Unload - ## Creation, Destruction and Logging of FMU Instances ```@docs @@ -106,6 +97,7 @@ fmi3DeSerializeFMUState fmi3DeSerializeFMUState! fmi3UpdateDiscreteStates fmi3EvaluateDiscreteStates +fmi3GetNominalsOfContinuousStates ``` ## Getting Partial Dervatives @@ -144,8 +136,8 @@ fmi3GetClock fmi3GetClock! fmi3SetClock fmi3ActivateModelPartition -fmi3CallbackClockUpdate ``` +fmi3CallbackClockUpdate ## Conversion functions diff --git a/src/FMI.jl b/src/FMI.jl index 9478f771..3cfdeba6 100644 --- a/src/FMI.jl +++ b/src/FMI.jl @@ -10,7 +10,7 @@ module FMI # reexport using FMIImport.FMIBase.Reexport @reexport using FMIImport -@reexport using FMIImport.FMIBase +@reexport using FMIImport.FMIBase @reexport using FMIImport.FMIBase.FMICore @reexport using FMIExport