Skip to content

Commit cd3bb35

Browse files
committed
fix doc
1 parent 9049f8c commit cd3bb35

File tree

5 files changed

+11
-12
lines changed

5 files changed

+11
-12
lines changed

docs/make.jl

Lines changed: 5 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ api_dir = joinpath(@__DIR__, "src", "api")
1212
api_files = map(x -> joinpath("api", x), readdir(api_dir))
1313
tutorial_files = readdir(tutorial_dir)
1414
md_tutorial_files = [split(file, ".")[1] * ".md" for file in tutorial_files]
15-
benchmark_files = readdir(benchmarks_dir)
16-
md_benchmark_files = [split(file, ".")[1] * ".md" for file in benchmark_files]
15+
benchmark_files = [joinpath("benchmarks", e) for e in readdir(benchmarks_dir)]
16+
# md_benchmark_files = [split(file, ".")[1] * ".md" for file in benchmark_files]
1717

1818
include_tutorial = true
1919

@@ -25,20 +25,14 @@ if include_tutorial
2525
end
2626

2727
makedocs(;
28-
modules=[DecisionFocusedLearningBenchmarks, DecisionFocusedLearningBenchmarks.Warcraft],
28+
modules=[DecisionFocusedLearningBenchmarks],
2929
authors="Members of JuliaDecisionFocusedLearning",
3030
sitename="DecisionFocusedLearningBenchmarks.jl",
31-
format=Documenter.HTML(),
31+
format=Documenter.HTML(; size_threshold=typemax(Int)),
3232
pages=[
3333
"Home" => "index.md",
3434
"Tutorials" => include_tutorial ? md_tutorial_files : [],
35-
"Benchmark problems list" => [
36-
"benchmarks/subset_selection.md",
37-
"benchmarks/fixed_size_shortest_path.md",
38-
"benchmarks/warcraft.md",
39-
"benchmarks/portfolio_optimization.md",
40-
"benchmarks/vsp.md",
41-
],
35+
"Benchmark problems list" => benchmark_files,
4236
"API reference" => api_files,
4337
],
4438
)

docs/src/benchmarks/argmax.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Argmax

docs/src/benchmarks/ranking.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Ranking

docs/src/tutorials/warcraft.jl

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -86,3 +86,6 @@ final_gap = compute_gap(b, test_dataset, model, maximizer)
8686
θ = model(x)
8787
y = maximizer(θ)
8888
plot_data(b, DataSample(; x, θ_true=θ, y_true=y))
89+
90+
using Test #src
91+
@test final_gap < starting_gap #src

src/DynamicVehicleScheduling/state.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ $TYPEDSIGNATURES
121121
122122
Check if the given routes are feasible.
123123
Routes should be given with global indexation.
124-
Use [`env_routes_from_state_routes`](@ref) if needed to convert the indices beforehand.
124+
Use `env_routes_from_state_routes` if needed to convert the indices beforehand.
125125
"""
126126
function is_feasible(state::DVSPState, routes::Vector{Vector{Int}}; verbose::Bool=false)
127127
(; is_must_dispatch, state_instance) = state

0 commit comments

Comments
 (0)