Skip to content

Commit 9a64f03

Browse files
pfitzsebpfitzseb
authored
Merge pull request #76 from JuliaComputing/mp/canonical-docs
docs: add docs for MultiDocRef, improve error handling
2 parents 735b92e + e074c47 commit 9a64f03

File tree

7 files changed

+361
-6
lines changed

7 files changed

+361
-6
lines changed

‎.github/workflows/deploy.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,9 @@ jobs:
2222
${{ runner.os }}-test-
2323
${{ runner.os }}-
2424
- name: Install dependencies
25-
run: julia --project=. -e 'using Pkg; Pkg.instantiate()'
25+
run: julia --project=docs/ -e 'using Pkg; Pkg.instantiate()'
2626
- name: Aggregate and deploy
2727
run: |
2828
git config user.name github-actions
2929
git config user.email [email protected]
30-
julia --project=. docs/make.jl deploy
30+
julia --project=docs/ docs/make.jl deploy

‎.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
11
/Manifest.toml
22
/docs/out/
33
/docs/clones/
4+
/docs/build/
5+
/docs/src/index.md
6+
/docs/src/sample.png

‎docs/Manifest.toml

Lines changed: 284 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,284 @@
1+
# This file is machine-generated - editing it directly is not advised
2+
3+
julia_version = "1.9.3"
4+
manifest_format = "2.0"
5+
project_hash = "7fb044d6009d35e78ff4aa48003f7ce74afa790b"
6+
7+
[[deps.ANSIColoredPrinters]]
8+
git-tree-sha1 = "574baf8110975760d391c710b6341da1afa48d8c"
9+
uuid = "a4c015fc-c6ff-483c-b24f-f7ea428134e9"
10+
version = "0.0.1"
11+
12+
[[deps.AbstractTrees]]
13+
git-tree-sha1 = "faa260e4cb5aba097a73fab382dd4b5819d8ec8c"
14+
uuid = "1520ce14-60c1-5f80-bbc7-55ef81b5835c"
15+
version = "0.4.4"
16+
17+
[[deps.ArgTools]]
18+
uuid = "0dad84c5-d112-42e6-8d28-ef12dabb789f"
19+
version = "1.1.1"
20+
21+
[[deps.Artifacts]]
22+
uuid = "56f22d72-fd6d-98f1-02f0-08ddc0907c33"
23+
24+
[[deps.Base64]]
25+
uuid = "2a0f44e3-6c83-55bd-87e4-b1978d98bd5f"
26+
27+
[[deps.Dates]]
28+
deps = ["Printf"]
29+
uuid = "ade2ca70-3891-5945-98fb-dc099432e06a"
30+
31+
[[deps.DocStringExtensions]]
32+
deps = ["LibGit2"]
33+
git-tree-sha1 = "2fb1e02f2b635d0845df5d7c167fec4dd739b00d"
34+
uuid = "ffbed154-4ef7-542d-bbb7-c09d3a79fcae"
35+
version = "0.9.3"
36+
37+
[[deps.Documenter]]
38+
deps = ["ANSIColoredPrinters", "AbstractTrees", "Base64", "Dates", "DocStringExtensions", "Downloads", "IOCapture", "InteractiveUtils", "JSON", "LibGit2", "Logging", "Markdown", "MarkdownAST", "Pkg", "PrecompileTools", "REPL", "RegistryInstances", "SHA", "Test", "Unicode"]
39+
git-tree-sha1 = "662fb21ae7fad33e044c2b59ece832fdce32c171"
40+
uuid = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
41+
version = "1.1.2"
42+
43+
[[deps.Downloads]]
44+
deps = ["ArgTools", "FileWatching", "LibCURL", "NetworkOptions"]
45+
uuid = "f43a241f-c20a-4ad4-852c-f6b1247861c6"
46+
version = "1.6.0"
47+
48+
[[deps.Expat_jll]]
49+
deps = ["Artifacts", "JLLWrappers", "Libdl"]
50+
git-tree-sha1 = "4558ab818dcceaab612d1bb8c19cee87eda2b83c"
51+
uuid = "2e619515-83b5-522b-bb60-26c02a35a201"
52+
version = "2.5.0+0"
53+
54+
[[deps.FileWatching]]
55+
uuid = "7b1f6079-737a-58dc-b8bc-7a2ca5c1b5ee"
56+
57+
[[deps.Git]]
58+
deps = ["Git_jll"]
59+
git-tree-sha1 = "51764e6c2e84c37055e846c516e9015b4a291c7d"
60+
uuid = "d7ba0133-e1db-5d97-8f8c-041e4b3a1eb2"
61+
version = "1.3.0"
62+
63+
[[deps.Git_jll]]
64+
deps = ["Artifacts", "Expat_jll", "JLLWrappers", "LibCURL_jll", "Libdl", "Libiconv_jll", "OpenSSL_jll", "PCRE2_jll", "Zlib_jll"]
65+
git-tree-sha1 = "bb8f7cc77ec1152414b2af6db533d9471cfbb2d1"
66+
uuid = "f8c6e375-362e-5223-8a59-34ff63f689eb"
67+
version = "2.42.0+0"
68+
69+
[[deps.Gumbo]]
70+
deps = ["AbstractTrees", "Gumbo_jll", "Libdl"]
71+
git-tree-sha1 = "a1a138dfbf9df5bace489c7a9d5196d6afdfa140"
72+
uuid = "708ec375-b3d6-5a57-a7ce-8257bf98657a"
73+
version = "0.8.2"
74+
75+
[[deps.Gumbo_jll]]
76+
deps = ["Artifacts", "JLLWrappers", "Libdl", "Pkg"]
77+
git-tree-sha1 = "29070dee9df18d9565276d68a596854b1764aa38"
78+
uuid = "528830af-5a63-567c-a44a-034ed33b8444"
79+
version = "0.10.2+0"
80+
81+
[[deps.HypertextLiteral]]
82+
deps = ["Tricks"]
83+
git-tree-sha1 = "7134810b1afce04bbc1045ca1985fbe81ce17653"
84+
uuid = "ac1192a8-f4b3-4bfe-ba22-af5b92cd3ab2"
85+
version = "0.9.5"
86+
87+
[[deps.IOCapture]]
88+
deps = ["Logging", "Random"]
89+
git-tree-sha1 = "d75853a0bdbfb1ac815478bacd89cd27b550ace6"
90+
uuid = "b5f81e59-6552-4d32-b1f0-c071b021bf89"
91+
version = "0.2.3"
92+
93+
[[deps.InteractiveUtils]]
94+
deps = ["Markdown"]
95+
uuid = "b77e0a4c-d291-57a0-90e8-8db25a27a240"
96+
97+
[[deps.JLLWrappers]]
98+
deps = ["Artifacts", "Preferences"]
99+
git-tree-sha1 = "7e5d6779a1e09a36db2a7b6cff50942a0a7d0fca"
100+
uuid = "692b3bcd-3c85-4b1f-b108-f13ce0eb3210"
101+
version = "1.5.0"
102+
103+
[[deps.JSON]]
104+
deps = ["Dates", "Mmap", "Parsers", "Unicode"]
105+
git-tree-sha1 = "31e996f0a15c7b280ba9f76636b3ff9e2ae58c9a"
106+
uuid = "682c06a0-de6a-54ab-a142-c8b1cf79cde6"
107+
version = "0.21.4"
108+
109+
[[deps.LazilyInitializedFields]]
110+
git-tree-sha1 = "410fe4739a4b092f2ffe36fcb0dcc3ab12648ce1"
111+
uuid = "0e77f7df-68c5-4e49-93ce-4cd80f5598bf"
112+
version = "1.2.1"
113+
114+
[[deps.LibCURL]]
115+
deps = ["LibCURL_jll", "MozillaCACerts_jll"]
116+
uuid = "b27032c2-a3e7-50c8-80cd-2d36dbcbfd21"
117+
version = "0.6.3"
118+
119+
[[deps.LibCURL_jll]]
120+
deps = ["Artifacts", "LibSSH2_jll", "Libdl", "MbedTLS_jll", "Zlib_jll", "nghttp2_jll"]
121+
uuid = "deac9b47-8bc7-5906-a0fe-35ac56dc84c0"
122+
version = "7.84.0+0"
123+
124+
[[deps.LibGit2]]
125+
deps = ["Base64", "NetworkOptions", "Printf", "SHA"]
126+
uuid = "76f85450-5226-5b5a-8eaa-529ad045b433"
127+
128+
[[deps.LibSSH2_jll]]
129+
deps = ["Artifacts", "Libdl", "MbedTLS_jll"]
130+
uuid = "29816b5a-b9ab-546f-933c-edad1886dfa8"
131+
version = "1.10.2+0"
132+
133+
[[deps.Libdl]]
134+
uuid = "8f399da3-3557-5675-b5ff-fb832c97cbdb"
135+
136+
[[deps.Libiconv_jll]]
137+
deps = ["Artifacts", "JLLWrappers", "Libdl"]
138+
git-tree-sha1 = "f9557a255370125b405568f9767d6d195822a175"
139+
uuid = "94ce4f54-9a6c-5748-9c1c-f9c7231a4531"
140+
version = "1.17.0+0"
141+
142+
[[deps.Logging]]
143+
uuid = "56ddb016-857b-54e1-b83d-db4d58db5568"
144+
145+
[[deps.Markdown]]
146+
deps = ["Base64"]
147+
uuid = "d6f4376e-aef5-505a-96c1-9c027394607a"
148+
149+
[[deps.MarkdownAST]]
150+
deps = ["AbstractTrees", "Markdown"]
151+
git-tree-sha1 = "465a70f0fc7d443a00dcdc3267a497397b8a3899"
152+
uuid = "d0879d2d-cac2-40c8-9cee-1863dc0c7391"
153+
version = "0.1.2"
154+
155+
[[deps.MbedTLS_jll]]
156+
deps = ["Artifacts", "Libdl"]
157+
uuid = "c8ffd9c3-330d-5841-b78e-0817d7145fa1"
158+
version = "2.28.2+0"
159+
160+
[[deps.Mmap]]
161+
uuid = "a63ad114-7e13-5084-954f-fe012c677804"
162+
163+
[[deps.MozillaCACerts_jll]]
164+
uuid = "14a3606d-f60d-562e-9121-12d972cd8159"
165+
version = "2022.10.11"
166+
167+
[[deps.MultiDocumenter]]
168+
deps = ["AbstractTrees", "Git", "Gumbo", "HypertextLiteral", "JSON", "NodeJS", "Pkg"]
169+
path = ".."
170+
uuid = "87ed4bf0-c935-4a67-83c3-2a03bee4197c"
171+
version = "0.7.0"
172+
173+
[[deps.NetworkOptions]]
174+
uuid = "ca575930-c2e3-43a9-ace4-1e988b2c1908"
175+
version = "1.2.0"
176+
177+
[[deps.NodeJS]]
178+
deps = ["Pkg"]
179+
git-tree-sha1 = "bf1f49fd62754064bc42490a8ddc2aa3694a8e7a"
180+
uuid = "2bd173c7-0d6d-553b-b6af-13a54713934c"
181+
version = "2.0.0"
182+
183+
[[deps.OpenSSL_jll]]
184+
deps = ["Artifacts", "JLLWrappers", "Libdl"]
185+
git-tree-sha1 = "cc6e1927ac521b659af340e0ca45828a3ffc748f"
186+
uuid = "458c3c95-2e84-50aa-8efc-19380b2a3a95"
187+
version = "3.0.12+0"
188+
189+
[[deps.PCRE2_jll]]
190+
deps = ["Artifacts", "Libdl"]
191+
uuid = "efcefdf7-47ab-520b-bdef-62a2eaa19f15"
192+
version = "10.42.0+0"
193+
194+
[[deps.Parsers]]
195+
deps = ["Dates", "PrecompileTools", "UUIDs"]
196+
git-tree-sha1 = "716e24b21538abc91f6205fd1d8363f39b442851"
197+
uuid = "69de0a69-1ddd-5017-9359-2bf0b02dc9f0"
198+
version = "2.7.2"
199+
200+
[[deps.Pkg]]
201+
deps = ["Artifacts", "Dates", "Downloads", "FileWatching", "LibGit2", "Libdl", "Logging", "Markdown", "Printf", "REPL", "Random", "SHA", "Serialization", "TOML", "Tar", "UUIDs", "p7zip_jll"]
202+
uuid = "44cfe95a-1eb2-52ea-b672-e2afdf69b78f"
203+
version = "1.9.2"
204+
205+
[[deps.PrecompileTools]]
206+
deps = ["Preferences"]
207+
git-tree-sha1 = "03b4c25b43cb84cee5c90aa9b5ea0a78fd848d2f"
208+
uuid = "aea7be01-6a6a-4083-8856-8a6e6704d82a"
209+
version = "1.2.0"
210+
211+
[[deps.Preferences]]
212+
deps = ["TOML"]
213+
git-tree-sha1 = "00805cd429dcb4870060ff49ef443486c262e38e"
214+
uuid = "21216c6a-2e73-6563-6e65-726566657250"
215+
version = "1.4.1"
216+
217+
[[deps.Printf]]
218+
deps = ["Unicode"]
219+
uuid = "de0858da-6303-5e67-8744-51eddeeeb8d7"
220+
221+
[[deps.REPL]]
222+
deps = ["InteractiveUtils", "Markdown", "Sockets", "Unicode"]
223+
uuid = "3fa0cd96-eef1-5676-8a61-b3b8758bbffb"
224+
225+
[[deps.Random]]
226+
deps = ["SHA", "Serialization"]
227+
uuid = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"
228+
229+
[[deps.RegistryInstances]]
230+
deps = ["LazilyInitializedFields", "Pkg", "TOML", "Tar"]
231+
git-tree-sha1 = "ffd19052caf598b8653b99404058fce14828be51"
232+
uuid = "2792f1a3-b283-48e8-9a74-f99dce5104f3"
233+
version = "0.1.0"
234+
235+
[[deps.SHA]]
236+
uuid = "ea8e919c-243c-51af-8825-aaa63cd721ce"
237+
version = "0.7.0"
238+
239+
[[deps.Serialization]]
240+
uuid = "9e88b42a-f829-5b0c-bbe9-9e923198166b"
241+
242+
[[deps.Sockets]]
243+
uuid = "6462fe0b-24de-5631-8697-dd941f90decc"
244+
245+
[[deps.TOML]]
246+
deps = ["Dates"]
247+
uuid = "fa267f1f-6049-4f14-aa54-33bafae1ed76"
248+
version = "1.0.3"
249+
250+
[[deps.Tar]]
251+
deps = ["ArgTools", "SHA"]
252+
uuid = "a4e569a6-e804-4fa4-b0f3-eef7a1d5b13e"
253+
version = "1.10.0"
254+
255+
[[deps.Test]]
256+
deps = ["InteractiveUtils", "Logging", "Random", "Serialization"]
257+
uuid = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
258+
259+
[[deps.Tricks]]
260+
git-tree-sha1 = "eae1bb484cd63b36999ee58be2de6c178105112f"
261+
uuid = "410a4b4d-49e4-4fbc-ab6d-cb71b17b3775"
262+
version = "0.1.8"
263+
264+
[[deps.UUIDs]]
265+
deps = ["Random", "SHA"]
266+
uuid = "cf7118a7-6976-5b1a-9a39-7adc72f591a4"
267+
268+
[[deps.Unicode]]
269+
uuid = "4ec0a83e-493e-50e2-b9ac-8f72acf5a8f5"
270+
271+
[[deps.Zlib_jll]]
272+
deps = ["Libdl"]
273+
uuid = "83775a58-1f1d-513f-b197-d71354ab007a"
274+
version = "1.2.13+0"
275+
276+
[[deps.nghttp2_jll]]
277+
deps = ["Artifacts", "Libdl"]
278+
uuid = "8e850ede-7688-5339-a07c-302acd2aaf8d"
279+
version = "1.48.0+0"
280+
281+
[[deps.p7zip_jll]]
282+
deps = ["Artifacts", "Libdl"]
283+
uuid = "3f19e933-33d8-53b3-aaab-bd5110c3b7a0"
284+
version = "17.4.0+0"

‎docs/Project.toml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
[deps]
2+
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
3+
MultiDocumenter = "87ed4bf0-c935-4a67-83c3-2a03bee4197c"

‎docs/make.jl

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
# `--temp`, in which case the source repositories are cloned into a temporary
88
# directory (as opposed to `docs/clones`).
99
using MultiDocumenter
10+
import Documenter
1011

1112
clonedir = ("--temp" in ARGS) ? mktempdir() : joinpath(@__DIR__, "clones")
1213
outpath = mktempdir()
@@ -15,7 +16,42 @@ Cloning packages into: $(clonedir)
1516
Building aggregate site into: $(outpath)
1617
"""
1718

19+
@info "Building Documenter site for MultiDocumenter"
20+
open(joinpath(@__DIR__, "src", "index.md"), write = true) do io
21+
write(io, read(joinpath(@__DIR__, "..", "README.md")))
22+
write(
23+
io,
24+
"""
25+
26+
## Docstrings
27+
28+
```@autodocs
29+
Modules = [MultiDocumenter]
30+
```
31+
""",
32+
)
33+
end
34+
cp(
35+
joinpath(@__DIR__, "..", "sample.png"),
36+
joinpath(@__DIR__, "src", "sample.png"),
37+
force = true,
38+
)
39+
Documenter.makedocs(
40+
sitename = "MultiDocumenter",
41+
modules = [MultiDocumenter],
42+
warnonly = true,
43+
pages = ["index.md", "internal.md"],
44+
)
45+
46+
@info "Building aggregate MultiDocumenter site"
1847
docs = [
48+
# We also add MultiDocumenter's own generated pages
49+
MultiDocumenter.MultiDocRef(
50+
upstream = joinpath(@__DIR__, "build"),
51+
path = "docs",
52+
name = "MultiDocumenter",
53+
fix_canonical_url = false,
54+
),
1955
MultiDocumenter.DropdownNav(
2056
"Debugging",
2157
[

‎docs/src/internal.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Internal docstrings
2+
3+
!!! warning "Not public API"
4+
5+
These functions are not part of the MultiDocumenter public API.
6+
7+
```@autodocs
8+
Modules = [MultiDocumenter.DocumenterTools]
9+
```

0 commit comments

Comments
 (0)