fix generation of documentation (#66)

exanauts · Sep 27, 2023 · ac946ee · ac946ee
1 parent 972b99c
commit ac946ee
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 5 deletions.
diff --git a/docs/make.jl b/docs/make.jl
@@ -5,6 +5,11 @@ Pkg.develop(PackageSpec(path=joinpath(dirname(@__FILE__), "..")))
 Pkg.instantiate()
 
 using Documenter, Argos
+using Pkg.Artifacts
+
+# Ensure ExaData is installed
+artifact_toml = joinpath(@__DIR__, "..", "Artifacts.toml")
+ensure_artifact_installed("ExaData", artifact_toml)
 
 makedocs(
     sitename = "Argos.jl",
@@ -14,7 +19,6 @@ makedocs(
     ),
     modules = [Argos],
     repo = "https://github.com/exanauts/Argos.jl/blob/{commit}{path}#{line}",
-    # strict = true,
     checkdocs = :exports,
     pages = [
         "Home" => "index.md",

diff --git a/src/Evaluators/full_space_evaluator.jl b/src/Evaluators/full_space_evaluator.jl
@@ -9,7 +9,7 @@ the internal `stack` by calling the function [`update!`](@ref)
 
 ## Examples
 
-```jldoctest; setup=:(using ExaPF, Argos)
+```jldoctest; setup=:(using ExaPF, Argos; ExaPF.load_polar("case9.m"))
 julia> flp = Argos.FullSpaceEvaluator(ExaPF.load_polar("case9.m"))
 A FullSpaceEvaluator object
     * device: CPU()

diff --git a/src/Evaluators/reduced_evaluator.jl b/src/Evaluators/reduced_evaluator.jl
@@ -20,7 +20,7 @@ The reduced evaluator could be instantiated on the host memory, or on a specific
 
 ## Examples
 
-```jldoctest; setup=:(using ExaPF, Argos)
+```jldoctest; setup=:(using ExaPF, Argos; ExaPF.load_polar("case9.m"))
 julia> nlp = Argos.ReducedSpaceEvaluator(ExaPF.load_polar("case9.m"))
 A ReducedSpaceEvaluator object
     * device: CPU()
@@ -38,8 +38,10 @@ julia> u = Argos.initial(nlp)
 
 julia> Argos.update!(nlp, u); # solve power-flow
 
-julia> Argos.objective(nlp, u) # get objective
-5438.323706833448
+julia> obj = Argos.objective(nlp, u); # get objective
+
+julia> obj ≈ 5438.323706
+true
 
 ```