Fix docs
Some checks failed
MetagraphOptimization_CI / prepare (push) Has been cancelled
MetagraphOptimization_CI / test (push) Has been cancelled
MetagraphOptimization_CI / docs (push) Has been cancelled

This commit is contained in:
Anton Reinhard 2023-09-17 11:20:10 +02:00
parent 4c452dce98
commit 62791ab422
6 changed files with 22 additions and 11 deletions

View File

@ -7,10 +7,12 @@ makedocs(
root = "docs",
source = "src",
build = "build",
warnonly = true,
clean = true,
doctest = true,
modules = Module[MetagraphOptimization],
repo = "https://code.woubery.com/Rubydragon/MetagraphOptimization.jl/src/branch/{commit}{path}#L{line}",
#repo = "https://code.woubery.com/Rubydragon/MetagraphOptimization.jl/src/branch/{commit}{path}#L{line}",
remotes = nothing,
sitename = "MetagraphOptimization.jl",
pages = [
"index.md",
@ -24,6 +26,7 @@ makedocs(
"Models" => "lib/internals/models.md",
"Diff" => "lib/internals/diff.md",
"Utility" => "lib/internals/utility.md",
"Code Generation" => "lib/internals/code_gen.md",
],
"Contribution" => "contribution.md",
],

View File

@ -0,0 +1,8 @@
# Code Generation
## Main
```@autodocs
Modules = [MetagraphOptimization]
Pages = ["code_gen/main.jl"]
Order = [:function]
```

View File

@ -13,7 +13,7 @@ Order = [:type, :constant]
```@autodocs
Modules = [MetagraphOptimization]
Pages = ["models/abc/particle.jl"]
Order = [:type, :constant]
Order = [:type, :constant, :function]
```
### Parse
@ -33,14 +33,14 @@ Order = [:function]
### Create
```@autodocs
Modules = [MetagraphOptimization]
Pages = ["models/abc/create.jl]
Pages = ["models/abc/create.jl"]
Order = [:function]
```
### Compute
```@autodocs
Modules = [MetagraphOptimization]
Pages = ["models/abc/compute.jl]
Pages = ["models/abc/compute.jl"]
Order = [:function]
```

View File

@ -10,7 +10,7 @@ Order = [:type]
## Create
```@autodocs
Modules = [MetagraphOptimization]
Pages = ["task/create.jl"]
Pages = ["properties/create.jl"]
Order = [:function]
```

View File

@ -3,7 +3,7 @@
## Helper Functions
```@autodocs
Modules = [MetagraphOptimization]
Pages = ["utility.jl"]
Pages = ["./utility.jl"]
Order = [:type, :function]
```

View File

@ -5,9 +5,9 @@ using DataStructures
Generate the code for a given graph. The return value is a tuple of:
- `code::Expr`: The julia expression containing the code for the whole graph.
- `inputSymbols::Dict{String, Symbol}`: A dictionary of symbols mapping the names of the input nodes of the graph to the symbols their inputs should be provided on.
- `outputSymbol::Symbol`: The symbol of the final calculated value
- `code::Expr`: The julia expression containing the code for the whole graph.
- `inputSymbols::Dict{String, Symbol}`: A dictionary of symbols mapping the names of the input nodes of the graph to the symbols their inputs should be provided on.
- `outputSymbol::Symbol`: The symbol of the final calculated value
See also: [`execute`](@ref)
"""
@ -53,7 +53,7 @@ end
"""
execute(generated_code, input::Dict{ParticleType, Vector{Particle}})
Execute the given generated_code (as returned by [`gen_code`](@ref)) on the given input particles.
Execute the given `generated_code` (as returned by [`gen_code`](@ref)) on the given input particles.
"""
function execute(generated_code, input::Dict{ParticleType, Vector{Particle}})
(code, inputSymbols, outputSymbol) = generated_code
@ -89,7 +89,7 @@ end
"""
execute(graph::DAG, input::Dict{ParticleType, Vector{Particle}})
Execute the given generated_code (as returned by [`gen_code`](@ref)) on the given input particles.
Execute the given `generated_code` (as returned by [`gen_code`](@ref)) on the given input particles.
The input particles should be sorted correctly into the dictionary to their according [`ParticleType`](@ref)s.
See also: [`gen_particles`](@ref)