Skip to content

Commit d665b8d

Browse files
authored
try using DocumenterInterLinks, see what happens (#248)
1 parent 2e0d3ef commit d665b8d

File tree

3 files changed

+17
-1
lines changed

3 files changed

+17
-1
lines changed

docs/Project.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
33
DocumenterVitepress = "4710194d-e776-4893-9690-8d956a29c365"
44
DocumenterCitations = "daee34ce-89f3-4625-b898-19384cb65244"
5+
DocumenterInterLinks = "d12716ef-a0f6-4df4-a9f1-a5a34e75c656"
56

67
[sources]
78
DocumenterVitepress = { path = ".." }

docs/make.jl

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
using Documenter
22
using DocumenterVitepress
33
using DocumenterCitations
4+
using DocumenterInterLinks
45

56
# Handle DocumenterCitations integration - if you're running this, then you don't need anything here!!
67
documenter_citations_dir = dirname(dirname(pathof(DocumenterCitations)))
@@ -23,6 +24,17 @@ bib = CitationBibliography(
2324
joinpath(@__DIR__, "src", "refs.bib");
2425
style=:numeric # default
2526
)
27+
28+
# Handle DocumenterInterLinks integration
29+
links = InterLinks(
30+
"sphinx" => "https://www.sphinx-doc.org/en/master/",
31+
"Documenter" => (
32+
"https://documenter.juliadocs.org/stable/",
33+
"https://documenter.juliadocs.org/stable/objects.inv",
34+
),
35+
);
36+
37+
2638
# dev local
2739

2840
makedocs(;
@@ -57,7 +69,7 @@ makedocs(;
5769
],
5870
"api.md",
5971
],
60-
plugins = [bib,],
72+
plugins = [bib, links],
6173
)
6274

6375

docs/src/api.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@ outline: deep
44
---
55
```
66

7+
See also the section about Documenter's [Writers](@extref Documenter).
8+
9+
710
## Public API
811

912
```@meta

0 commit comments

Comments
 (0)