Skip to content

Commit 9499f45

Browse files
committed
added detailed index
1 parent 8a17e53 commit 9499f45

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

docs/src/index.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
# LightGraphsMatching.jl: matching algorithms for LightGraphs
2+
13
```@meta
24
CurrentModule = LightGraphsMatching
35
DocTestSetup = quote
@@ -12,3 +14,12 @@ Modules = [LightGraphsMatching]
1214
Pages = ["LightGraphsMatching.jl", "maximum_weight_matching.jl", "lp.jl", "blossomv.jl"]
1315
Order = [:function, :type]
1416
```
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

Comments
 (0)