Export docs

.github/workflows/Example.yml

@@ -41,10 +41,17 @@ jobs:
         run: pip install jupyter nbconvert
 
       - name: "Execute notebook"
+        env:
+          FILE: examples/jupyter-src/${{ matrix.file-name }}.ipynb
+        run: jupyter nbconvert --ExecutePreprocessor.kernel_name="julia-${{ matrix.julia-version }}" --to notebook --inplace --execute ${{ env.FILE }}
+
+      - name: "Fix SVGs" # on notebook (json) level: removes all cells, that have the tag "text/html" AND have "<?xml " within their content
+        run: julia -e 'using Pkg; Pkg.add("JSON"); using JSON; data = JSON.parsefile(joinpath("examples", "jupyter-src", "${{ matrix.file-name }}.ipynb"); use_mmap=false); function search_and_remove!(json, tag, content=""); if typeof(json) == Vector{Any}; for e in json; search_and_remove!(e, tag, content); end; elseif typeof(json) == Dict{String, Any}; for (t, c) in json; if contains(t, tag) && (content == "" || any([contains(line, content) for line in c])); pop!(json, t); else; search_and_remove!(c, tag, content); end; end; end; end; search_and_remove!(data, "text/html", "<?xml "); open(joinpath("examples", "jupyter-src", "tmp_${{ matrix.file-name }}.ipynb"),"w") do f; JSON.print(f, data, 1); end; mv(joinpath("examples", "jupyter-src", "tmp_${{ matrix.file-name }}.ipynb"), joinpath("examples", "jupyter-src", "${{ matrix.file-name }}.ipynb"); force=true);'
+
+      - name: "Export notebook to jl and md"
         env:
           FILE: examples/jupyter-src/${{ matrix.file-name }}.ipynb
         run: |
-          jupyter nbconvert --ExecutePreprocessor.kernel_name="julia-${{ matrix.julia-version }}" --to notebook --inplace --execute ${{ env.FILE }}
           jupyter nbconvert --to script ${{ env.FILE }}
           jupyter nbconvert --to markdown ${{ env.FILE }}
 

docs/Project.toml

@@ -4,6 +4,7 @@ DataFrames = "a93c6f00-e57d-5684-b7b6-d8193f3e46c0"
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
 FMIBase = "900ee838-d029-460e-b485-d98a826ceef2"
 FMICore = "8af89139-c281-408e-bce2-3005eb87462f"
+FMIExport = "31b88311-cab6-44ed-ba9c-fe5a9abbd67a"
 FMIImport = "9fcbc62e-52a0-44e9-a616-1359a0008194"
 JLD2 = "033835bb-8acc-5ee8-8aae-3f567f8a3819"
 JuliaFormatter = "98e50ef6-434e-11e9-1051-2b60c6c9e899"

docs/make.jl

@@ -5,7 +5,9 @@
 
 import Pkg;
 Pkg.develop(path = joinpath(@__DIR__, "../../FMI.jl"));
-using Documenter, Plots, JLD2, DataFrames, CSV, MAT, FMI, FMIBase, FMIImport, FMICore
+using Plots, JLD2, DataFrames, CSV, MAT # need to be loaded, as they enable optional features in FMI.jl
+using FMI, FMIBase, FMIImport, FMICore, FMIExport
+using Documenter
 using Documenter: GitHubActions
 using Suppressor
 
@@ -97,7 +99,7 @@ my_makedocs() = makedocs(
             "fmi3_lowlevel_library_functions.md",
         ],
     ),
-    modules = [FMI, FMIImport, FMICore, FMIBase],
+    modules = [FMI, FMIImport, FMIExport, FMICore, FMIBase],
     checkdocs = :exports,
     linkcheck = true,
     warnonly = :linkcheck,

docs/src/fmi2_lowlevel_library_functions.md

@@ -104,3 +104,15 @@ fmi2GetJacobian
 fmi2GetJacobian!
 fmi2GetFullJacobian
 fmi2GetFullJacobian!
+
+## Export functions
+
+```@docs
+fmi2ModelDescriptionAddModelStructureOutputs
+fmi2CreateEmbedded
+fmi2ModelDescriptionAddModelStructureInitialUnknowns
+fmi2ModelDescriptionAddModelVariable
+fmi2CreateSimple
+fmi2Create
+fmi2ModelDescriptionAddModelStructureDerivatives
+```

examples/jupyter-src/manipulation.ipynb

@@ -42,7 +42,7 @@
     "\n",
     "\n",
     "## Other formats\n",
-    "Besides, this [Jupyter Notebook](https://github.com/thummeto/FMI.jl/blob/examples/examples/src/manipulation.ipynb) there is also a [Julia file](https://github.com/thummeto/FMI.jl/blob/examples/examples/src/manipulation.jl) with the same name, which contains only the code cells and for the documentation there is a [Markdown file](https://github.com/thummeto/FMI.jl/blob/examples/examples/src/manipulation.md) corresponding to the notebook.  "
+    "Besides, this [Jupyter Notebook](https://github.com/thummeto/FMI.jl/blob/examples/examples/jupyter-src/manipulation.ipynb) there is also a [Julia file](https://github.com/thummeto/FMI.jl/blob/examples/examples/jupyter-src/manipulation.jl) with the same name, which contains only the code cells and for the documentation there is a [Markdown file](https://github.com/thummeto/FMI.jl/blob/examples/examples/jupyter-src/manipulation.md) corresponding to the notebook.  "
    ]
   },
   {

examples/jupyter-src/multiple_instances.ipynb

@@ -49,7 +49,7 @@
     "\n",
     "\n",
     "## Other formats\n",
-    "Besides, this [Jupyter Notebook](https://github.com/thummeto/FMI.jl/blob/examples/examples/src/multiple_instances.ipynb) there is also a [Julia file](https://github.com/thummeto/FMI.jl/blob/examples/examples/src/multiple_instances.jl) with the same name, which contains only the code cells and for the documentation there is a [Markdown file](https://github.com/thummeto/FMI.jl/blob/examples/examples/src/multiple_instances.md) corresponding to the notebook.  \n",
+    "Besides, this [Jupyter Notebook](https://github.com/thummeto/FMI.jl/blob/examples/examples/jupyter-src/multiple_instances.ipynb) there is also a [Julia file](https://github.com/thummeto/FMI.jl/blob/examples/examples/jupyter-src/multiple_instances.jl) with the same name, which contains only the code cells and for the documentation there is a [Markdown file](https://github.com/thummeto/FMI.jl/blob/examples/examples/jupyter-src/multiple_instances.md) corresponding to the notebook.  \n",
     "\n",
     "\n",
     "## Getting started\n",

examples/jupyter-src/multiprocessing.ipynb

@@ -55,7 +55,7 @@
     "\n",
     "\n",
     "## Other formats\n",
-    "Besides, this [Jupyter Notebook](https://github.com/thummeto/FMI.jl/blob/examples/examples/src/multiprocessing.ipynb) there is also a [Julia file](https://github.com/thummeto/FMI.jl/blob/examples/examples/src/multiprocessing.jl) with the same name, which contains only the code cells and for the documentation there is a [Markdown file](https://github.com/thummeto/FMI.jl/blob/examples/examples/src/multiprocessing.md) corresponding to the notebook.  \n",
+    "Besides, this [Jupyter Notebook](https://github.com/thummeto/FMI.jl/blob/examples/examples/jupyter-src/multiprocessing.ipynb) there is also a [Julia file](https://github.com/thummeto/FMI.jl/blob/examples/examples/jupyter-src/multiprocessing.jl) with the same name, which contains only the code cells and for the documentation there is a [Markdown file](https://github.com/thummeto/FMI.jl/blob/examples/examples/jupyter-src/multiprocessing.md) corresponding to the notebook.  \n",
     "\n",
     "\n",
     "## Getting started\n",