Merge pull request #37 from JuliaDecisionFocusedLearning/assortment-doc

Cleanup dynamic assortment

Author: BatyLeo

docs/make.jl

@@ -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
 
@@ -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",
     ],
 )
 

docs/src/api/0_interface.md

@@ -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
+```