Merge pull request #30 from JuliaGraphs/fix-docs

Author: simsurace

README.md

@@ -2,6 +2,7 @@
 
 [![Build status](https://github.com/JuliaGraphs/GraphsMatching.jl/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/JuliaGraphs/GraphsMatching.jl/actions/workflows/ci.yml?query=branch%3Amaster)
 [![codecov](https://codecov.io/github/JuliaGraphs/GraphsMatching.jl/branch/master/graph/badge.svg?token=2eGhm8xuNl)](https://codecov.io/github/JuliaGraphs/GraphsMatching.jl/tree/master)
+[![](https://img.shields.io/badge/docs-dev-blue.svg)](https://juliagraphs.org/GraphsMatching.jl/dev/)
 [![ColPrac: Contributor's Guide on Collaborative Practices for Community Packages](https://img.shields.io/badge/ColPrac-Contributor's%20Guide-blueviolet)](https://github.com/SciML/ColPrac)
 
 Matching algorithms on top of [Graphs.jl](https://github.com/JuliaGraphs/Graphs.jl).

docs/Project.toml

@@ -0,0 +1,4 @@
+[deps]
+Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
+Graphs = "86223c79-3864-5bf0-83f7-82e725a168b6"
+GraphsMatching = "c3af3a8c-b79e-4b01-bf44-c718d7e0e0d6"

docs/make.jl

@@ -4,18 +4,18 @@ import Graphs
 
 makedocs(
     modules = [GraphsMatching],
-    format = :html,
+    format = Documenter.HTML(),
     sitename = "GraphsMatching",
 	pages = Any[
 		"Getting started"         => "index.md",
+		"API"                     => "API.md",
+		"Internals"               => "internals.md",
     ]
 )
 
 deploydocs(
     deps        = nothing,
     make        = nothing,
     repo        = "github.com/JuliaGraphs/GraphsMatching.jl.git",
-    target      = "build",
-    julia       = "0.6",
-    osname      = "linux"
+    versions = ["stable" => "v^", "v#.#", "dev" => "master"],
 )

docs/src/API.md

@@ -0,0 +1,10 @@
+# API
+
+```@docs     
+GraphsMatching.minimum_weight_perfect_matching
+GraphsMatching.maximum_weight_maximal_matching
+GraphsMatching.LEMONMWPMAlgorithm
+GraphsMatching.LPAlgorithm
+GraphsMatching.HungarianAlgorithm
+GraphsMatching.BlossomVAlgorithm
+```

docs/src/internals.md

@@ -0,0 +1,7 @@
+# Internals
+
+```@docs
+GraphsMatching.AbstractMinimumWeightPerfectMatchingAlgorithm
+GraphsMatching.AbstractMaximumWeightMaximalMatchingAlgorithm
+GraphsMatching.cutoff_weights
+```