moved docs from FMIImport&Core into FMI.jl #204
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
0815Creeper
commented
Nov 21, 2023
| using Documenter: GitHubActions | ||
|
|
||
| makedocs(sitename="FMI.jl", | ||
| format = Documenter.HTML( | ||
| collapselevel = 1, | ||
| sidebar_sitename = false, | ||
| edit_link = nothing | ||
| edit_link = nothing, | ||
| size_threshold_ignore = ["library.md","deprecated.md","fmi2_lowlevel_librarys.md","fmi3_lowlevel_librarys.md"] |
There was a problem hiding this comment.
necessary, will be removed as soon as library.md and fmiX_lowlevel_librarys.md are spilt just as fmi_lowlevel_library_types, _functions, _constants
0815Creeper
commented
Nov 21, 2023
| modules = [FMI, FMIImport, FMICore], | ||
| checkdocs=:exports, | ||
| linkcheck=true, | ||
| linkcheck_ignore=["https://thummeto.github.io/FMI.jl/dev/examples/inputs/", "https://github.com/ThummeTo/FMICore.jl/blob/main/src/FMI2_c.jl#L718"], |
There was a problem hiding this comment.
examples need work, old links in there will be ignored until then ...
0815Creeper
commented
Nov 21, 2023
| "Related Publication" => "related.md" | ||
| "Contents" => "contents.md" | ||
| ] | ||
| ) | ||
| hide("Deprecated" => "deprecated.md") |
There was a problem hiding this comment.
all exported funtions need to be documented. The coresponding file will be hidden (might be removable by removing docstrings from deprececated functions)
0815Creeper
commented
Nov 21, 2023
| @@ -20,7 +20,7 @@ jobs: | |||
| matrix: | |||
| os: [windows-latest] # ubuntu-latest | |||
| file-name: [manipulation, modelica_conference_2021, multiple_instances, multiprocessing, multithreading, parameterize, simulate, parameter_optimization] | |||
| julia-version: ['1.9'] | |||
| julia-version: ['1.8'] | |||
There was a problem hiding this comment.
fixed, that examples were broken (no svgs where saved)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.