From 0540014c58aa7d90c9cdf5564ee9b20769ae08f2 Mon Sep 17 00:00:00 2001 From: Simone Carlo Surace <51025924+simsurace@users.noreply.github.com> Date: Tue, 21 Oct 2025 14:49:34 +0200 Subject: [PATCH 1/9] Create Project.toml for docs --- docs/Project.toml | 4 ++++ 1 file changed, 4 insertions(+) create mode 100644 docs/Project.toml diff --git a/docs/Project.toml b/docs/Project.toml new file mode 100644 index 0000000..0c5b738 --- /dev/null +++ b/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" From ae73ef4d71db77905a10dd7716fa7ab49bfdfc51 Mon Sep 17 00:00:00 2001 From: Simone Carlo Surace <51025924+simsurace@users.noreply.github.com> Date: Tue, 21 Oct 2025 14:53:16 +0200 Subject: [PATCH 2/9] Add docs badge --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 8d8e844..671aadd 100644 --- a/README.md +++ b/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). From 6af13a2213f6c511cddd065a883ea6d798650f3e Mon Sep 17 00:00:00 2001 From: Simone Carlo Surace <51025924+simsurace@users.noreply.github.com> Date: Tue, 21 Oct 2025 14:55:52 +0200 Subject: [PATCH 3/9] Fix make.jl --- docs/make.jl | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/make.jl b/docs/make.jl index 09cbb83..e0ec28a 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -4,7 +4,7 @@ import Graphs makedocs( modules = [GraphsMatching], - format = :html, + format = Documenter.HTML(), sitename = "GraphsMatching", pages = Any[ "Getting started" => "index.md", From b5914b2908ca7bfad1c59bf1d0c28fa717ed36b4 Mon Sep 17 00:00:00 2001 From: Simone Carlo Surace <51025924+simsurace@users.noreply.github.com> Date: Tue, 21 Oct 2025 16:04:16 +0200 Subject: [PATCH 4/9] Create internals.md --- docs/src/internals.md | 7 +++++++ 1 file changed, 7 insertions(+) create mode 100644 docs/src/internals.md diff --git a/docs/src/internals.md b/docs/src/internals.md new file mode 100644 index 0000000..181ea35 --- /dev/null +++ b/docs/src/internals.md @@ -0,0 +1,7 @@ +# Internals + +```@docs +GraphsMatching.AbstractMinimumWeightPerfectMatchingAlgorithm +GraphsMatching.AbstractMaximumWeightMaximalMatchingAlgorithm +GraphsMatching.cutoff_weights +``` From 71dd460a8f4aef7886de068f867b693269691277 Mon Sep 17 00:00:00 2001 From: Simone Carlo Surace <51025924+simsurace@users.noreply.github.com> Date: Tue, 21 Oct 2025 16:04:52 +0200 Subject: [PATCH 5/9] Add internals to make.jl --- docs/make.jl | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/make.jl b/docs/make.jl index e0ec28a..5f46c34 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -8,6 +8,7 @@ makedocs( sitename = "GraphsMatching", pages = Any[ "Getting started" => "index.md", + "Internals" => "internals.md", ] ) From 2385959666d7409d2b9bb17c9ee80c024f7c7474 Mon Sep 17 00:00:00 2001 From: Simone Carlo Surace <51025924+simsurace@users.noreply.github.com> Date: Tue, 21 Oct 2025 16:06:59 +0200 Subject: [PATCH 6/9] Create API.jl --- docs/src/API.jl | 10 ++++++++++ 1 file changed, 10 insertions(+) create mode 100644 docs/src/API.jl diff --git a/docs/src/API.jl b/docs/src/API.jl new file mode 100644 index 0000000..ca6551d --- /dev/null +++ b/docs/src/API.jl @@ -0,0 +1,10 @@ +# API + +```@docs +GraphsMatching.minimum_weight_perfect_matching +GraphsMatching.maximum_weight_maximal_matching +GraphsMatching.LEMONMWPMAlgorithm +GraphsMatching.LPAlgorithm +GraphsMatching.HungarianAlgorithm +GraphsMatching.BlossomVAlgorithm +``` From 5d25aa2b99229256d3e7f53fac7f42b76b1ef83e Mon Sep 17 00:00:00 2001 From: Simone Carlo Surace <51025924+simsurace@users.noreply.github.com> Date: Tue, 21 Oct 2025 16:07:32 +0200 Subject: [PATCH 7/9] Add API to make.jl --- docs/make.jl | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/make.jl b/docs/make.jl index 5f46c34..4197927 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -8,6 +8,7 @@ makedocs( sitename = "GraphsMatching", pages = Any[ "Getting started" => "index.md", + "API" => "API.md", "Internals" => "internals.md", ] ) From dea75c759864f4181985e89ee0b57e42a4ee4060 Mon Sep 17 00:00:00 2001 From: Simone Carlo Surace <51025924+simsurace@users.noreply.github.com> Date: Tue, 21 Oct 2025 16:11:10 +0200 Subject: [PATCH 8/9] Fix file extension --- docs/src/{API.jl => API.md} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename docs/src/{API.jl => API.md} (100%) diff --git a/docs/src/API.jl b/docs/src/API.md similarity index 100% rename from docs/src/API.jl rename to docs/src/API.md From 312ff44a1c82300903cd031eb2b95956e6042533 Mon Sep 17 00:00:00 2001 From: Simone Carlo Surace <51025924+simsurace@users.noreply.github.com> Date: Tue, 21 Oct 2025 22:49:21 +0200 Subject: [PATCH 9/9] Fix keywords to `deploydocs` --- docs/make.jl | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/docs/make.jl b/docs/make.jl index 4197927..b9963c9 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -17,7 +17,5 @@ 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"], )