Tree search API doc (#687)

atoptima · Aug 17, 2022 · 5a8ea08 · 5a8ea08
1 parent 95be1b9
commit 5a8ea08
Show file tree

Hide file tree

Showing 15 changed files with 1,024 additions and 24 deletions.
diff --git a/docs/Project.toml b/docs/Project.toml
@@ -8,6 +8,7 @@ GLPK = "60bf3e95-4087-53dc-ae20-288a0d20c6a6"
 JuMP = "4076af6c-e467-56ae-b986-b466b2749572"
 Literate = "98b081ad-f1c9-55d3-8b20-4c87d4299306"
 MathOptInterface = "b8f27783-ece8-5eb3-8dc8-9495eed66fee"
+Parameters = "d96e819e-fc66-5662-9728-84c9c7592b0a"
 
 [compat]
 BlockDecomposition = "1.6"

diff --git a/docs/make.jl b/docs/make.jl
@@ -1,19 +1,22 @@
-using Documenter, Coluna, Literate, BlockDecomposition
+using Documenter, Coluna, Literate, BlockDecomposition, Parameters
 
 TUTORIAL_GAP = joinpath(@__DIR__, "src", "start", "start.jl")
 TUTORIAL_CUTS = joinpath(@__DIR__, "src", "start", "cuts.jl")
 TUTORIAL_PRICING = joinpath(@__DIR__, "src", "start", "pricing.jl")
 TUTORIAL_INITCOLS = joinpath(@__DIR__, "src", "start", "initial_columns.jl")
+TUTORIAL_TREESEARCH_API = joinpath(@__DIR__, "src", "api", "treesearch.jl")
 
 OUTPUT_GAP = joinpath(@__DIR__, "src", "start")
 OUTPUT_CUTS = joinpath(@__DIR__, "src", "start")
 OUTPUT_PRICING = joinpath(@__DIR__, "src", "start")
 OUTPUT_INITCOLS = joinpath(@__DIR__, "src", "start")
+OUTPUT_TREESEARCH_API = joinpath(@__DIR__, "src", "api")
 
 Literate.markdown(TUTORIAL_GAP, OUTPUT_GAP, documenter=true)
 Literate.markdown(TUTORIAL_CUTS, OUTPUT_CUTS, documenter=true)
 Literate.markdown(TUTORIAL_PRICING, OUTPUT_PRICING, documenter=true)
 Literate.markdown(TUTORIAL_INITCOLS, OUTPUT_INITCOLS, documenter=true)
+Literate.markdown(TUTORIAL_TREESEARCH_API, OUTPUT_TREESEARCH_API, documenter=true)
 
 makedocs(
     modules = [Coluna, BlockDecomposition],
@@ -22,7 +25,8 @@ makedocs(
     authors = "Atoptima & contributors",
     format = Documenter.HTML(
         prettyurls = get(ENV, "CI", nothing) == "true",
-        collapselevel = 1
+        collapselevel = 1,
+        assets = ["assets/js/init.js"]
     ),
     strict = false,
     pages = Any[
@@ -31,15 +35,18 @@ makedocs(
             "Column generation" => joinpath("start", "start.md"),
             "Valid inequalities" => joinpath("start", "cuts.md"),
             "Pricing callback" => joinpath("start", "pricing.md"),
-            "Initial columns callback" => joinpath("start", "initial_columns.md")
+            "Initial columns callback" => joinpath("start", "initial_columns.md"),
         ],
         "Manual" => Any[
             "Decomposition" => joinpath("man", "decomposition.md"),
             "Configuration" => joinpath("man", "config.md"),
             "Algorithms" => joinpath("man", "algorithm.md"),
-            "Callbacks"   => joinpath("man", "callbacks.md")
+            "Callbacks"   => joinpath("man", "callbacks.md"),
         ],
-        "Q&A" => "qa.md"
+        "API" => Any[
+            "Tree Search" => joinpath("api", "treesearch.md"),
+        ],
+        "Q&A" => "qa.md",
     ]
 )