From de0227b9c66fe1ddb7dc7eb007fa783b44dea0d2 Mon Sep 17 00:00:00 2001 From: Carsten Bauer Date: Fri, 27 Sep 2024 10:25:32 +0200 Subject: [PATCH] documenterinterlinks (#127) --- docs/Project.toml | 2 ++ docs/make.jl | 12 +++++++++++- docs/src/refs/api.md | 20 ++++++++++---------- 3 files changed, 23 insertions(+), 11 deletions(-) diff --git a/docs/Project.toml b/docs/Project.toml index 03a1cda3..9cb27843 100644 --- a/docs/Project.toml +++ b/docs/Project.toml @@ -1,7 +1,9 @@ [deps] Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4" +DocumenterInterLinks = "d12716ef-a0f6-4df4-a9f1-a5a34e75c656" DocumenterTools = "35a29f4d-8980-5a13-9543-d66fff28ecb8" [compat] Documenter = "1.3" +DocumenterInterLinks = "1" DocumenterTools = "0.1" diff --git a/docs/make.jl b/docs/make.jl index 19f8b78e..bbd2dd26 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -1,8 +1,17 @@ using Documenter +using DocumenterInterLinks using OhMyThreads const ci = get(ENV, "CI", "") == "true" +links = InterLinks( + "ChunkSplitters" => ( + "https://juliafolds2.github.io/ChunkSplitters.jl/stable/", + "https://juliafolds2.github.io/ChunkSplitters.jl/stable/objects.inv", + joinpath(@__DIR__, "inventories", "ChunkSplitters.toml") + ), +); + @info "Generating Documenter.jl site" makedocs(; sitename = "OhMyThreads.jl", @@ -30,7 +39,8 @@ makedocs(; ] ], repo = "https://github.com/JuliaFolds2/OhMyThreads.jl/blob/{commit}{path}#{line}", - format = Documenter.HTML(repolink = "https://github.com/JuliaFolds2/OhMyThreads.jl"; collapselevel = 1)) + format = Documenter.HTML(repolink = "https://github.com/JuliaFolds2/OhMyThreads.jl"; collapselevel = 1), + plugins = [links],) if ci @info "Deploying documentation to GitHub" diff --git a/docs/src/refs/api.md b/docs/src/refs/api.md index 7f85308d..039f8147 100644 --- a/docs/src/refs/api.md +++ b/docs/src/refs/api.md @@ -41,21 +41,21 @@ SerialScheduler | | | |------------------------|---------------------------------------------------------------------| -| `OhMyThreads.chunks` | see [ChunkSplitters.jl](https://juliafolds2.github.io/ChunkSplitters.jl/stable/references/#ChunkSplitters.chunks) | -| `OhMyThreads.index_chunks` | see [ChunkSplitters.jl](https://juliafolds2.github.io/ChunkSplitters.jl/stable/references/#ChunkSplitters.index_chunks) | +| `OhMyThreads.chunks` | see [`ChunkSplitters.chunks`](@extref) | +| `OhMyThreads.index_chunks` | see [`ChunkSplitters.index_chunks`](@extref) | ## Public but not exported | | | |------------------------|---------------------------------------------------------------------| -| `OhMyThreads.@spawn` | see [StableTasks.jl](https://github.com/JuliaFolds2/StableTasks.jl) | -| `OhMyThreads.@spawnat` | see [StableTasks.jl](https://github.com/JuliaFolds2/StableTasks.jl) | -| `OhMyThreads.@fetch` | see [StableTasks.jl](https://github.com/JuliaFolds2/StableTasks.jl) | -| `OhMyThreads.@fetchfrom` | see [StableTasks.jl](https://github.com/JuliaFolds2/StableTasks.jl) | -| `OhMyThreads.TaskLocalValue` | see [TaskLocalValues.jl](https://github.com/vchuravy/TaskLocalValues.jl) | -| `OhMyThreads.Split` | see [ChunkSplitters.jl](https://juliafolds2.github.io/ChunkSplitters.jl/stable/references/#ChunkSplitters.Split) | -| `OhMyThreads.Consecutive` | see [ChunkSplitters.jl](https://juliafolds2.github.io/ChunkSplitters.jl/stable/references/#ChunkSplitters.Consecutive) | -| `OhMyThreads.RoundRobin` | see [ChunkSplitters.jl](https://juliafolds2.github.io/ChunkSplitters.jl/stable/references/#ChunkSplitters.RoundRobin) | +| `OhMyThreads.@spawn` | see [`StableTasks.@spawn`](https://github.com/JuliaFolds2/StableTasks.jl) | +| `OhMyThreads.@spawnat` | see [`StableTasks.@spawnat`](https://github.com/JuliaFolds2/StableTasks.jl) | +| `OhMyThreads.@fetch` | see [`StableTasks.@fetch`](https://github.com/JuliaFolds2/StableTasks.jl) | +| `OhMyThreads.@fetchfrom` | see [`StableTasks.@fetchfrom`](https://github.com/JuliaFolds2/StableTasks.jl) | +| `OhMyThreads.TaskLocalValue` | see [TaskLocalValues.TaskLocalValue](https://github.com/vchuravy/TaskLocalValues.jl) | +| `OhMyThreads.Split` | see [`ChunkSplitters.Split`](@extref) | +| `OhMyThreads.Consecutive` | see [`ChunkSplitters.Consecutive`](@extref) | +| `OhMyThreads.RoundRobin` | see [`ChunkSplitters.RoundRobin`](@extref) | ```@docs