Skip to content

Commit ac946ee

Browse files
authored
fix generation of documentation (#66)
1 parent 972b99c commit ac946ee

File tree

3 files changed

+11
-5
lines changed

3 files changed

+11
-5
lines changed

docs/make.jl

+5-1
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,11 @@ Pkg.develop(PackageSpec(path=joinpath(dirname(@__FILE__), "..")))
55
Pkg.instantiate()
66

77
using Documenter, Argos
8+
using Pkg.Artifacts
9+
10+
# Ensure ExaData is installed
11+
artifact_toml = joinpath(@__DIR__, "..", "Artifacts.toml")
12+
ensure_artifact_installed("ExaData", artifact_toml)
813

914
makedocs(
1015
sitename = "Argos.jl",
@@ -14,7 +19,6 @@ makedocs(
1419
),
1520
modules = [Argos],
1621
repo = "https://github.com/exanauts/Argos.jl/blob/{commit}{path}#{line}",
17-
# strict = true,
1822
checkdocs = :exports,
1923
pages = [
2024
"Home" => "index.md",

src/Evaluators/full_space_evaluator.jl

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ the internal `stack` by calling the function [`update!`](@ref)
99
1010
## Examples
1111
12-
```jldoctest; setup=:(using ExaPF, Argos)
12+
```jldoctest; setup=:(using ExaPF, Argos; ExaPF.load_polar("case9.m"))
1313
julia> flp = Argos.FullSpaceEvaluator(ExaPF.load_polar("case9.m"))
1414
A FullSpaceEvaluator object
1515
* device: CPU()

src/Evaluators/reduced_evaluator.jl

+5-3
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ The reduced evaluator could be instantiated on the host memory, or on a specific
2020
2121
## Examples
2222
23-
```jldoctest; setup=:(using ExaPF, Argos)
23+
```jldoctest; setup=:(using ExaPF, Argos; ExaPF.load_polar("case9.m"))
2424
julia> nlp = Argos.ReducedSpaceEvaluator(ExaPF.load_polar("case9.m"))
2525
A ReducedSpaceEvaluator object
2626
* device: CPU()
@@ -38,8 +38,10 @@ julia> u = Argos.initial(nlp)
3838
3939
julia> Argos.update!(nlp, u); # solve power-flow
4040
41-
julia> Argos.objective(nlp, u) # get objective
42-
5438.323706833448
41+
julia> obj = Argos.objective(nlp, u); # get objective
42+
43+
julia> obj ≈ 5438.323706
44+
true
4345
4446
```
4547

0 commit comments

Comments
 (0)