fixes for doc

0815Creeper · Oct 6, 2023 · 17c00fe · 17c00fe
1 parent 66f7b68
commit 17c00fe
Show file tree

Hide file tree

Showing 7 changed files with 149 additions and 267 deletions.
diff --git a/docs/make.jl b/docs/make.jl
@@ -3,16 +3,18 @@
 # Licensed under the MIT license. See LICENSE file in the project root for details.
 #
 
-using Documenter, FMI, Plots, FMIImport
+using Documenter, FMI, Plots, FMIImport, FMICore
 using Documenter: GitHubActions
 
 makedocs(sitename="FMI.jl",
          format = Documenter.HTML(
             collapselevel = 1,
             sidebar_sitename = false,
             edit_link = nothing,
-            size_threshold_ignore = ["fmi2_library.md"]
+            size_threshold_ignore = ["fmi_import_library.md","fmi2_import_library.md","fmi3_import_library.md"]
          ),
+         modules = [FMI, FMIImport, FMICore],#, FMIBuild]
+         checkdocs=:none,#:exports,
          warnonly=true,
          pages= Any[
             "Introduction" => "index.md"
@@ -28,9 +30,17 @@ makedocs(sitename="FMI.jl",
                 "Multithreading" => "examples/multithreading.md"
                 "Multiprocessing" => "examples/multiprocessing.md"
             ]
-            "Developer Level API" => "fmi2_library.md"
-            #"" => "fmi3_library.md"
             "User Level API" => "library.md"
+            "Developer Level API" => Any[
+                #"fmi_import_library.md",
+                "fmi2_import_library.md",
+                "fmi3_import_library.md"
+            ]
+            "Foundation Level API" => Any[
+                #"fmi_core_library.md",
+                "fmi2_core_library.md",
+                "fmi3_core_library.md"
+            ]
             "Related Publication" => "related.md"
             "Contents" => "contents.md"
             ]

diff --git a/docs/src/fmi2_library.md b/docs/src/fmi2_library.md
diff --git a/docs/src/fmi3_library.md b/docs/src/fmi3_library.md
diff --git a/docs/src/library.md b/docs/src/library.md
@@ -30,3 +30,22 @@ fmiInfo
 ```@docs
 fmiPlot
 ```
+
+# FMI2 specific
+
+```@docs
+fmi2Info
+fmi2Simulate
+fmi2SimulateME
+fmi2SimulateCS
+```
+
+# FMI3 specific
+
+```@docs
+fmi3Info
+fmi3Simulate
+fmi3SimulateME
+fmi3SimulateSE
+fmi3SimulateCS
+```
diff --git a/src/FMI.jl b/src/FMI.jl
@@ -107,6 +107,8 @@ export FMU3ExecutionConfiguration, FMU3_EXECUTION_CONFIGURATION_RESET, FMU3_EXEC
 using FMIImport: prepareValue, prepareValueReference
 
 export fmi2Real, fmi2Integer, fmi2String, fmi2Enumeration, fmi2Boolean
+export fmi2Info, fmi3Info
+export fmi2GetDependencies, fmi3GetDependencies
 
 include("check.jl")
 
@@ -1329,6 +1331,8 @@ function fmiGetReal(str::fmi3Struct, args...; kwargs...)
     fmi3GetReal(str, args...; kwargs...)
 end
 
+export fmiGetReal
+
 
 """
     fmiSampleJacobian(str::fmi2Struct, c::FMU2Component,