start documentation

Author: flixpar

.gitignore

@@ -20,3 +20,6 @@ results/
 
 # data
 data/
+
+# doc
+/docs/build/

docs/make.jl

@@ -0,0 +1,12 @@
+using Documenter
+using QuadraticAssignmentProblem
+
+makedocs(
+	sitename="QuadraticAssignmentProblem.jl",
+	pages = [
+		"index.md",
+		"solvers.md",
+		"generators.md",
+		"util.md",
+	],
+)

docs/src/generators.md

@@ -0,0 +1,8 @@
+# Instance Generators
+
+```@docs
+uniform_matrix
+metric_matrix
+zeroone_matrix
+generate_qap
+```

docs/src/index.md

@@ -0,0 +1,21 @@
+# QuadraticAssignmentProblem.jl
+
+```@contents
+Pages = ["index.md", "solvers.md", "generators.md", "util.md"]
+```
+
+Algorithms for (approximately) solving the quadratic assignment problem (QAP) implemented in Julia.
+
+Exact algorithms:
+- Quadratic integer programming
+- Linearization
+
+Approximation algorithms:
+- "On the Maximum Quadratic Assignment Problem" by Nagarajan and Sviridenko (NS)
+- "Maximum Quadratic Assignment Problem: Reduction from Maximum Label Cover and LP-based Approximation Algorithm" by Makarychev, Manokaran, and Sviridenko (MMS)
+
+Heuristic algorithms:
+- Fast Approximate QAP
+- Random search
+- LP + LAP rounding
+

docs/src/solvers.md

@@ -0,0 +1,11 @@
+# Solvers
+
+```@docs
+qap_exact
+qap_linearization
+qap_lprounding
+qap_random
+qap_mms
+qap_ns
+faq
+```

docs/src/util.md

@@ -0,0 +1,5 @@
+# Utility Functions
+
+```@docs
+qap_objective
+```