We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
There was an error while loading. Please reload this page.
2 parents 6842250 + 9499f45 commit 84b45bbCopy full SHA for 84b45bb
docs/src/index.md
@@ -1,3 +1,5 @@
1
+ # LightGraphsMatching.jl: matching algorithms for LightGraphs
2
+
3
```@meta
4
CurrentModule = LightGraphsMatching
5
DocTestSetup = quote
@@ -12,3 +14,12 @@ Modules = [LightGraphsMatching]
12
14
Pages = ["LightGraphsMatching.jl", "maximum_weight_matching.jl", "lp.jl", "blossomv.jl"]
13
15
Order = [:function, :type]
16
```
17
18
+This is the documentation page for `LightGraphsMatching`.
19
+In all documentation examples, we assume LightGraphsMatching has been imported into scope
20
+and that LightGraphs is available with the alias `lg`:
21
+```julia
22
+using LightGraphsMatching
23
+import LightGraphs
24
+const lg = LightGraphs
25
+```
0 commit comments