Skip to content

Fix issues in the documentation #337

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
gdalle merged 1 commit into from
Sep 4, 2026
Merged

Fix issues in the documentation #337

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 15 additions & 1 deletion docs/make.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 = "<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->"
const CONTRIBUTORS_END = "<!-- ALL-CONTRIBUTORS-LIST: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],
Expand Down
2 changes: 1 addition & 1 deletion docs/src/vis.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading