cleanup doc

Author: BatyLeo

docs/make.jl

@@ -7,13 +7,15 @@ cp(joinpath(@__DIR__, "..", "README.md"), joinpath(@__DIR__, "src", "index.md");
 md_dir = joinpath(@__DIR__, "src")
 tutorial_dir = joinpath(@__DIR__, "src", "tutorials")
 benchmarks_dir = joinpath(@__DIR__, "src", "benchmarks")
+api_dir = joinpath(@__DIR__, "src", "api")
 
+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 = readdir(benchmarks_dir)
 md_benchmark_files = [split(file, ".")[1] * ".md" for file in benchmark_files]
 
-include_tutorial = true
+include_tutorial = false
 
 if include_tutorial
     for file in tutorial_files
@@ -37,8 +39,7 @@ makedocs(;
             "benchmarks/portfolio_optimization.md",
             "benchmarks/vsp.md",
         ],
-        "API reference" =>
-            ["api/interface.md", "api/decision_focused.md", "api/warcraft.md"],
+        "API reference" => api_files,
     ],
 )
 

docs/src/api/interface.md renamed to docs/src/api/0_interface.md

@@ -0,0 +1,15 @@
+# Fixed-size shortest path
+
+## Public
+
+```@autodocs
+Modules = [DecisionFocusedLearningBenchmarks.FixedSizeShortestPath]
+Private = false
+```
+
+## Private
+
+```@autodocs
+Modules = [DecisionFocusedLearningBenchmarks.FixedSizeShortestPath]
+Public = false
+```

docs/src/api/decision_focused.md

@@ -0,0 +1,15 @@
+# Subset selection
+
+## Public
+
+```@autodocs
+Modules = [DecisionFocusedLearningBenchmarks.PortfolioOptimization]
+Private = false
+```
+
+## Private
+
+```@autodocs
+Modules = [DecisionFocusedLearningBenchmarks.PortfolioOptimization]
+Public = false
+```

docs/src/api/fixed_shortest_path.md

@@ -0,0 +1,15 @@
+# Subset selection
+
+## Public
+
+```@autodocs
+Modules = [DecisionFocusedLearningBenchmarks.SubsetSelection]
+Private = false
+```
+
+## Private
+
+```@autodocs
+Modules = [DecisionFocusedLearningBenchmarks.SubsetSelection]
+Public = false
+```