From 3ebc77ae726aca2669fd07c1d7ae884153c0749e Mon Sep 17 00:00:00 2001 From: Alexis Montoison Date: Fri, 4 Sep 2026 07:52:03 -0600 Subject: [PATCH] Fix issues in the documentation --- docs/make.jl | 16 +++++++++++++++- docs/src/vis.md | 2 +- 2 files changed, 16 insertions(+), 2 deletions(-) diff --git a/docs/make.jl b/docs/make.jl index 80d2a23d..6b16274b 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -4,7 +4,21 @@ using SparseMatrixColorings links = InterLinks("ADTypes" => "https://sciml.github.io/ADTypes.jl/stable/") -cp(joinpath(@__DIR__, "..", "README.md"), joinpath(@__DIR__, "src", "index.md"); force=true) +# The README is reused as the documentation homepage. +# Julia's Markdown parser does not support raw HTML, so the all-contributors table +# has to be wrapped in a `@raw html` block, and the anchor of the "Contributors" +# heading has to be capitalized the way Documenter generates it. +const CONTRIBUTORS_START = "" +const CONTRIBUTORS_END = "" + +readme = read(joinpath(@__DIR__, "..", "README.md"), String) +index = replace( + readme, + "](#contributors)" => "](#Contributors)", + CONTRIBUTORS_START => "```@raw html\n" * CONTRIBUTORS_START, + CONTRIBUTORS_END => CONTRIBUTORS_END * "\n```", +) +write(joinpath(@__DIR__, "src", "index.md"), index) makedocs(; modules=[SparseMatrixColorings], diff --git a/docs/src/vis.md b/docs/src/vis.md index f1f9e7b3..afd4bcb3 100644 --- a/docs/src/vis.md +++ b/docs/src/vis.md @@ -60,7 +60,7 @@ Finally, a background color can be passed via the `background` keyword argument. We demonstrate this on a bidirectional coloring. -```@example img; continue = true +```@example img; continued = true S = sparse([ 1 1 1 1 1 1 1 1 1 1 0 0 0 0 0 0 0 1