Skip to content

Commit

Permalink
documenterinterlinks (#127)
Browse files Browse the repository at this point in the history
  • Loading branch information
carstenbauer authored Sep 27, 2024
1 parent a301d00 commit de0227b
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 11 deletions.
2 changes: 2 additions & 0 deletions docs/Project.toml
Original file line number Diff line number Diff line change
@@ -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"
12 changes: 11 additions & 1 deletion docs/make.jl
Original file line number Diff line number Diff line change
@@ -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",
Expand Down Expand Up @@ -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"
Expand Down
20 changes: 10 additions & 10 deletions docs/src/refs/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit de0227b

Please sign in to comment.