Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ api_files = map(x -> joinpath("api", x), readdir(api_dir))
tutorial_files = readdir(tutorial_dir)
md_tutorial_files = [split(file, ".")[1] * ".md" for file in tutorial_files]
benchmark_files = [joinpath("benchmarks", e) for e in readdir(benchmarks_dir)]
# md_benchmark_files = [split(file, ".")[1] * ".md" for file in benchmark_files]

include_tutorial = true

Expand All @@ -33,7 +32,7 @@ makedocs(;
"Home" => "index.md",
"Tutorials" => include_tutorial ? md_tutorial_files : [],
"Benchmark problems list" => benchmark_files,
"API reference" => api_files,
"API reference" => "api/api.md",
],
)

Expand Down
19 changes: 0 additions & 19 deletions docs/src/api/0_interface.md

This file was deleted.

177 changes: 177 additions & 0 deletions docs/src/api/api.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,177 @@
# API Reference

## Interface

### Public

```@autodocs
Modules = [DecisionFocusedLearningBenchmarks.Utils]
Private = false
```

### Private

```@autodocs
Modules = [DecisionFocusedLearningBenchmarks.Utils]
Public = false
```

## Argmax2D

### Public

```@autodocs
Modules = [DecisionFocusedLearningBenchmarks.Argmax2D]
Private = false
```

### Private

```@autodocs
Modules = [DecisionFocusedLearningBenchmarks.Argmax2D]
Public = false
```

## Argmax

### Public

```@autodocs
Modules = [DecisionFocusedLearningBenchmarks.Argmax]
Private = false
```

### Private

```@autodocs
Modules = [DecisionFocusedLearningBenchmarks.Argmax]
Public = false
```

## Dynamic Vehicle Scheduling

### Public

```@autodocs
Modules = [DecisionFocusedLearningBenchmarks.DynamicVehicleScheduling]
Private = false
```

### Private

```@autodocs
Modules = [DecisionFocusedLearningBenchmarks.DynamicVehicleScheduling]
Public = false
```

## Dynamic Assortment

### Public

```@autodocs
Modules = [DecisionFocusedLearningBenchmarks.DynamicAssortment]
Private = false
```

### Private

```@autodocs
Modules = [DecisionFocusedLearningBenchmarks.DynamicAssortment]
Public = false
```

## Fixed-size shortest path

### Public

```@autodocs
Modules = [DecisionFocusedLearningBenchmarks.FixedSizeShortestPath]
Private = false
```

### Private

```@autodocs
Modules = [DecisionFocusedLearningBenchmarks.FixedSizeShortestPath]
Public = false
```

## Portfolio Optimization

### Public

```@autodocs
Modules = [DecisionFocusedLearningBenchmarks.PortfolioOptimization]
Private = false
```

### Private

```@autodocs
Modules = [DecisionFocusedLearningBenchmarks.PortfolioOptimization]
Public = false
```

## Ranking

### Public

```@autodocs
Modules = [DecisionFocusedLearningBenchmarks.Ranking]
Private = false
```

### Private

```@autodocs
Modules = [DecisionFocusedLearningBenchmarks.Ranking]
Public = false
```

## Subset selection

### Public

```@autodocs
Modules = [DecisionFocusedLearningBenchmarks.SubsetSelection]
Private = false
```

### Private

```@autodocs
Modules = [DecisionFocusedLearningBenchmarks.SubsetSelection]
Public = false
```

## Stochastic Vehicle Scheduling

### Public

```@autodocs
Modules = [DecisionFocusedLearningBenchmarks.StochasticVehicleScheduling]
Private = false
```

### Private

```@autodocs
Modules = [DecisionFocusedLearningBenchmarks.StochasticVehicleScheduling]
Public = false
```

## Warcraft

### Public

```@autodocs
Modules = [DecisionFocusedLearningBenchmarks.Warcraft]
Private = false
```

### Private

```@autodocs
Modules = [DecisionFocusedLearningBenchmarks.Warcraft]
Public = false
```
19 changes: 0 additions & 19 deletions docs/src/api/argmax.md

This file was deleted.

19 changes: 0 additions & 19 deletions docs/src/api/argmax_2d.md

This file was deleted.

19 changes: 0 additions & 19 deletions docs/src/api/dvsp.md

This file was deleted.

19 changes: 0 additions & 19 deletions docs/src/api/dynamic_assorment.md

This file was deleted.

19 changes: 0 additions & 19 deletions docs/src/api/fixed_shortest_path.md

This file was deleted.

19 changes: 0 additions & 19 deletions docs/src/api/portfolio_optimization.md

This file was deleted.

19 changes: 0 additions & 19 deletions docs/src/api/ranking.md

This file was deleted.

19 changes: 0 additions & 19 deletions docs/src/api/subset_selection.md

This file was deleted.

19 changes: 0 additions & 19 deletions docs/src/api/vsp.md

This file was deleted.

Loading