Skip to content

Commit e0d9cb2

Browse files
mortenpiLilithHafner
mortenpi
and
LilithHafner
authored
Update Documenter 0.27.23 => 1.2.1 (#47105)
Currently mainly to test a few things on CI here, but will update this to an actual PR once 0.28.0 is out. --------- Co-authored-by: Lilith Orion Hafner <[email protected]>
1 parent d0e7ec0 commit e0d9cb2

File tree

3 files changed

+231
-17
lines changed

3 files changed

+231
-17
lines changed

‎doc/Manifest.toml

Lines changed: 165 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -9,47 +9,109 @@ git-tree-sha1 = "574baf8110975760d391c710b6341da1afa48d8c"
99
uuid = "a4c015fc-c6ff-483c-b24f-f7ea428134e9"
1010
version = "0.0.1"
1111

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+
1221
[[deps.Artifacts]]
1322
uuid = "56f22d72-fd6d-98f1-02f0-08ddc0907c33"
23+
version = "1.11.0"
1424

1525
[[deps.Base64]]
1626
uuid = "2a0f44e3-6c83-55bd-87e4-b1978d98bd5f"
27+
version = "1.11.0"
1728

1829
[[deps.Dates]]
1930
deps = ["Printf"]
2031
uuid = "ade2ca70-3891-5945-98fb-dc099432e06a"
32+
version = "1.11.0"
2133

2234
[[deps.DocStringExtensions]]
2335
deps = ["LibGit2"]
24-
git-tree-sha1 = "5158c2b41018c5f7eb1470d558127ac274eca0c9"
36+
git-tree-sha1 = "2fb1e02f2b635d0845df5d7c167fec4dd739b00d"
2537
uuid = "ffbed154-4ef7-542d-bbb7-c09d3a79fcae"
26-
version = "0.9.1"
38+
version = "0.9.3"
2739

2840
[[deps.Documenter]]
29-
deps = ["ANSIColoredPrinters", "Base64", "Dates", "DocStringExtensions", "IOCapture", "InteractiveUtils", "JSON", "LibGit2", "Logging", "Markdown", "REPL", "Test", "Unicode"]
30-
git-tree-sha1 = "6030186b00a38e9d0434518627426570aac2ef95"
41+
deps = ["ANSIColoredPrinters", "AbstractTrees", "Base64", "Dates", "DocStringExtensions", "Downloads", "Git", "IOCapture", "InteractiveUtils", "JSON", "LibGit2", "Logging", "Markdown", "MarkdownAST", "Pkg", "PrecompileTools", "REPL", "RegistryInstances", "SHA", "Test", "Unicode"]
42+
git-tree-sha1 = "2613dbec8f4748273bbe30ba71fd5cb369966bac"
3143
uuid = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
32-
version = "0.27.23"
44+
version = "1.2.1"
45+
46+
[[deps.Downloads]]
47+
deps = ["ArgTools", "FileWatching", "LibCURL", "NetworkOptions"]
48+
uuid = "f43a241f-c20a-4ad4-852c-f6b1247861c6"
49+
version = "1.6.0"
50+
51+
[[deps.Expat_jll]]
52+
deps = ["Artifacts", "JLLWrappers", "Libdl"]
53+
git-tree-sha1 = "4558ab818dcceaab612d1bb8c19cee87eda2b83c"
54+
uuid = "2e619515-83b5-522b-bb60-26c02a35a201"
55+
version = "2.5.0+0"
56+
57+
[[deps.FileWatching]]
58+
uuid = "7b1f6079-737a-58dc-b8bc-7a2ca5c1b5ee"
59+
version = "1.11.0"
60+
61+
[[deps.Git]]
62+
deps = ["Git_jll"]
63+
git-tree-sha1 = "51764e6c2e84c37055e846c516e9015b4a291c7d"
64+
uuid = "d7ba0133-e1db-5d97-8f8c-041e4b3a1eb2"
65+
version = "1.3.0"
66+
67+
[[deps.Git_jll]]
68+
deps = ["Artifacts", "Expat_jll", "JLLWrappers", "LibCURL_jll", "Libdl", "Libiconv_jll", "OpenSSL_jll", "PCRE2_jll", "Zlib_jll"]
69+
git-tree-sha1 = "bb8f7cc77ec1152414b2af6db533d9471cfbb2d1"
70+
uuid = "f8c6e375-362e-5223-8a59-34ff63f689eb"
71+
version = "2.42.0+0"
3372

3473
[[deps.IOCapture]]
3574
deps = ["Logging", "Random"]
36-
git-tree-sha1 = "f7be53659ab06ddc986428d3a9dcc95f6fa6705a"
75+
git-tree-sha1 = "d75853a0bdbfb1ac815478bacd89cd27b550ace6"
3776
uuid = "b5f81e59-6552-4d32-b1f0-c071b021bf89"
38-
version = "0.2.2"
77+
version = "0.2.3"
3978

4079
[[deps.InteractiveUtils]]
4180
deps = ["Markdown"]
4281
uuid = "b77e0a4c-d291-57a0-90e8-8db25a27a240"
82+
version = "1.11.0"
83+
84+
[[deps.JLLWrappers]]
85+
deps = ["Artifacts", "Preferences"]
86+
git-tree-sha1 = "7e5d6779a1e09a36db2a7b6cff50942a0a7d0fca"
87+
uuid = "692b3bcd-3c85-4b1f-b108-f13ce0eb3210"
88+
version = "1.5.0"
4389

4490
[[deps.JSON]]
4591
deps = ["Dates", "Mmap", "Parsers", "Unicode"]
46-
git-tree-sha1 = "3c837543ddb02250ef42f4738347454f95079d4e"
92+
git-tree-sha1 = "31e996f0a15c7b280ba9f76636b3ff9e2ae58c9a"
4793
uuid = "682c06a0-de6a-54ab-a142-c8b1cf79cde6"
48-
version = "0.21.3"
94+
version = "0.21.4"
95+
96+
[[deps.LazilyInitializedFields]]
97+
git-tree-sha1 = "8f7f3cabab0fd1800699663533b6d5cb3fc0e612"
98+
uuid = "0e77f7df-68c5-4e49-93ce-4cd80f5598bf"
99+
version = "1.2.2"
100+
101+
[[deps.LibCURL]]
102+
deps = ["LibCURL_jll", "MozillaCACerts_jll"]
103+
uuid = "b27032c2-a3e7-50c8-80cd-2d36dbcbfd21"
104+
version = "0.6.4"
105+
106+
[[deps.LibCURL_jll]]
107+
deps = ["Artifacts", "LibSSH2_jll", "Libdl", "MbedTLS_jll", "Zlib_jll", "nghttp2_jll"]
108+
uuid = "deac9b47-8bc7-5906-a0fe-35ac56dc84c0"
109+
version = "8.4.0+0"
49110

50111
[[deps.LibGit2]]
51112
deps = ["Base64", "LibGit2_jll", "NetworkOptions", "Printf", "SHA"]
52113
uuid = "76f85450-5226-5b5a-8eaa-529ad045b433"
114+
version = "1.11.0"
53115

54116
[[deps.LibGit2_jll]]
55117
deps = ["Artifacts", "LibSSH2_jll", "Libdl", "MbedTLS_jll"]
@@ -63,13 +125,28 @@ version = "1.11.0+1"
63125

64126
[[deps.Libdl]]
65127
uuid = "8f399da3-3557-5675-b5ff-fb832c97cbdb"
128+
version = "1.11.0"
129+
130+
[[deps.Libiconv_jll]]
131+
deps = ["Artifacts", "JLLWrappers", "Libdl"]
132+
git-tree-sha1 = "f9557a255370125b405568f9767d6d195822a175"
133+
uuid = "94ce4f54-9a6c-5748-9c1c-f9c7231a4531"
134+
version = "1.17.0+0"
66135

67136
[[deps.Logging]]
68137
uuid = "56ddb016-857b-54e1-b83d-db4d58db5568"
138+
version = "1.11.0"
69139

70140
[[deps.Markdown]]
71141
deps = ["Base64"]
72142
uuid = "d6f4376e-aef5-505a-96c1-9c027394607a"
143+
version = "1.11.0"
144+
145+
[[deps.MarkdownAST]]
146+
deps = ["AbstractTrees", "Markdown"]
147+
git-tree-sha1 = "465a70f0fc7d443a00dcdc3267a497397b8a3899"
148+
uuid = "d0879d2d-cac2-40c8-9cee-1863dc0c7391"
149+
version = "0.1.2"
73150

74151
[[deps.MbedTLS_jll]]
75152
deps = ["Artifacts", "Libdl"]
@@ -78,42 +155,118 @@ version = "2.28.2+1"
78155

79156
[[deps.Mmap]]
80157
uuid = "a63ad114-7e13-5084-954f-fe012c677804"
158+
version = "1.11.0"
159+
160+
[[deps.MozillaCACerts_jll]]
161+
uuid = "14a3606d-f60d-562e-9121-12d972cd8159"
162+
version = "2023.1.10"
81163

82164
[[deps.NetworkOptions]]
83165
uuid = "ca575930-c2e3-43a9-ace4-1e988b2c1908"
84166
version = "1.2.0"
85167

168+
[[deps.OpenSSL_jll]]
169+
deps = ["Artifacts", "JLLWrappers", "Libdl"]
170+
git-tree-sha1 = "cc6e1927ac521b659af340e0ca45828a3ffc748f"
171+
uuid = "458c3c95-2e84-50aa-8efc-19380b2a3a95"
172+
version = "3.0.12+0"
173+
174+
[[deps.PCRE2_jll]]
175+
deps = ["Artifacts", "Libdl"]
176+
uuid = "efcefdf7-47ab-520b-bdef-62a2eaa19f15"
177+
version = "10.42.0+1"
178+
86179
[[deps.Parsers]]
87-
deps = ["Dates"]
88-
git-tree-sha1 = "3d5bf43e3e8b412656404ed9466f1dcbf7c50269"
180+
deps = ["Dates", "PrecompileTools", "UUIDs"]
181+
git-tree-sha1 = "a935806434c9d4c506ba941871b327b96d41f2bf"
89182
uuid = "69de0a69-1ddd-5017-9359-2bf0b02dc9f0"
90-
version = "2.4.0"
183+
version = "2.8.0"
184+
185+
[[deps.Pkg]]
186+
deps = ["Artifacts", "Dates", "Downloads", "FileWatching", "LibGit2", "Libdl", "Logging", "Markdown", "Printf", "REPL", "Random", "SHA", "Serialization", "TOML", "Tar", "UUIDs", "p7zip_jll"]
187+
uuid = "44cfe95a-1eb2-52ea-b672-e2afdf69b78f"
188+
version = "1.11.0"
189+
190+
[[deps.PrecompileTools]]
191+
deps = ["Preferences"]
192+
git-tree-sha1 = "03b4c25b43cb84cee5c90aa9b5ea0a78fd848d2f"
193+
uuid = "aea7be01-6a6a-4083-8856-8a6e6704d82a"
194+
version = "1.2.0"
195+
196+
[[deps.Preferences]]
197+
deps = ["TOML"]
198+
git-tree-sha1 = "00805cd429dcb4870060ff49ef443486c262e38e"
199+
uuid = "21216c6a-2e73-6563-6e65-726566657250"
200+
version = "1.4.1"
91201

92202
[[deps.Printf]]
93203
deps = ["Unicode"]
94204
uuid = "de0858da-6303-5e67-8744-51eddeeeb8d7"
205+
version = "1.11.0"
95206

96207
[[deps.REPL]]
97208
deps = ["InteractiveUtils", "Markdown", "Sockets", "Unicode"]
98209
uuid = "3fa0cd96-eef1-5676-8a61-b3b8758bbffb"
210+
version = "1.11.0"
99211

100212
[[deps.Random]]
101213
deps = ["SHA"]
102214
uuid = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"
215+
version = "1.11.0"
216+
217+
[[deps.RegistryInstances]]
218+
deps = ["LazilyInitializedFields", "Pkg", "TOML", "Tar"]
219+
git-tree-sha1 = "ffd19052caf598b8653b99404058fce14828be51"
220+
uuid = "2792f1a3-b283-48e8-9a74-f99dce5104f3"
221+
version = "0.1.0"
103222

104223
[[deps.SHA]]
105224
uuid = "ea8e919c-243c-51af-8825-aaa63cd721ce"
106225
version = "0.7.0"
107226

108227
[[deps.Serialization]]
109228
uuid = "9e88b42a-f829-5b0c-bbe9-9e923198166b"
229+
version = "1.11.0"
110230

111231
[[deps.Sockets]]
112232
uuid = "6462fe0b-24de-5631-8697-dd941f90decc"
233+
version = "1.11.0"
234+
235+
[[deps.TOML]]
236+
deps = ["Dates"]
237+
uuid = "fa267f1f-6049-4f14-aa54-33bafae1ed76"
238+
version = "1.0.3"
239+
240+
[[deps.Tar]]
241+
deps = ["ArgTools", "SHA"]
242+
uuid = "a4e569a6-e804-4fa4-b0f3-eef7a1d5b13e"
243+
version = "1.10.0"
113244

114245
[[deps.Test]]
115246
deps = ["InteractiveUtils", "Logging", "Random", "Serialization"]
116247
uuid = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
248+
version = "1.11.0"
249+
250+
[[deps.UUIDs]]
251+
deps = ["Random", "SHA"]
252+
uuid = "cf7118a7-6976-5b1a-9a39-7adc72f591a4"
253+
version = "1.11.0"
117254

118255
[[deps.Unicode]]
119256
uuid = "4ec0a83e-493e-50e2-b9ac-8f72acf5a8f5"
257+
version = "1.11.0"
258+
259+
[[deps.Zlib_jll]]
260+
deps = ["Libdl"]
261+
uuid = "83775a58-1f1d-513f-b197-d71354ab007a"
262+
version = "1.2.13+1"
263+
264+
[[deps.nghttp2_jll]]
265+
deps = ["Artifacts", "Libdl"]
266+
uuid = "8e850ede-7688-5339-a07c-302acd2aaf8d"
267+
version = "1.58.0+0"
268+
269+
[[deps.p7zip_jll]]
270+
deps = ["Artifacts", "Libdl"]
271+
uuid = "3f19e933-33d8-53b3-aaab-bd5110c3b7a0"
272+
version = "17.4.0+2"

‎doc/make.jl

Lines changed: 66 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ using Pkg
88
Pkg.instantiate()
99

1010
using Documenter
11+
import LibGit2
1112

1213
baremodule GenStdLib end
1314

@@ -42,6 +43,68 @@ cd(joinpath(@__DIR__, "src")) do
4243
end
4344
end
4445

46+
# Because we have standard libraries that are hosted outside of the julia repo,
47+
# but their docs are included in the manual, we need to populate the remotes argument
48+
# of makedocs(), to make sure that Documenter knows how to resolve the directories
49+
# in stdlib/ to the correct remote Git repositories (for source and edit links).
50+
#
51+
# This function parses the *.version files in stdlib/, returning a dictionary with
52+
# all the key-value pairs from those files. *_GIT_URL and *_SHA1 fields are the ones
53+
# we will actually be interested in.
54+
function parse_stdlib_version_file(path)
55+
values = Dict{String,String}()
56+
for line in readlines(path)
57+
m = match(r"^([A-Z0-9_]+)\s+:?=\s+(\S+)$", line)
58+
if isnothing(m)
59+
@warn "Unable to parse line in $(path)" line
60+
else
61+
values[m[1]] = m[2]
62+
end
63+
end
64+
return values
65+
end
66+
# This generates the value that will be passed to the `remotes` argument of makedocs(),
67+
# by looking through all *.version files in stdlib/.
68+
documenter_stdlib_remotes = let stdlib_dir = realpath(joinpath(@__DIR__, "..", "stdlib"))
69+
# Get a list of all *.version files in stdlib/..
70+
version_files = filter(readdir(stdlib_dir)) do fname
71+
isfile(joinpath(stdlib_dir, fname)) && endswith(fname, ".version")
72+
end
73+
# .. and then parse them, each becoming an entry for makedocs's remotes.
74+
# The values for each are of the form path => (remote, sha1), where
75+
# - path: the path to the stdlib package's root directory, i.e. "stdlib/$PACKAGE"
76+
# - remote: a Documenter.Remote object, pointing to the Git repository where package is hosted
77+
# - sha1: the SHA1 of the commit that is included with the current Julia version
78+
remotes_list = map(version_files) do version_fname
79+
package = match(r"(.+)\.version", version_fname)[1]
80+
versionfile = parse_stdlib_version_file(joinpath(stdlib_dir, version_fname))
81+
# From the (all uppercase) $(package)_GIT_URL and $(package)_SHA1 fields, we'll determine
82+
# the necessary information. If this logic happens to fail for some reason for any of the
83+
# standard libraries, we'll crash the documentation build, so that it could be fixed.
84+
remote = let git_url_key = "$(uppercase(package))_GIT_URL"
85+
haskey(versionfile, git_url_key) || error("Missing $(git_url_key) in $version_fname")
86+
m = match(LibGit2.GITHUB_REGEX, versionfile[git_url_key])
87+
isnothing(m) && error("Unable to parse $(git_url_key)='$(versionfile[git_url_key])' in $version_fname")
88+
Documenter.Remotes.GitHub(m[2], m[3])
89+
end
90+
package_sha = let sha_key = "$(uppercase(package))_SHA1"
91+
haskey(versionfile, sha_key) || error("Missing $(sha_key) in $version_fname")
92+
versionfile[sha_key]
93+
end
94+
# Construct the absolute (local) path to the stdlib package's root directory
95+
package_root_dir = joinpath(stdlib_dir, "$(package)-$(package_sha)")
96+
# Documenter needs package_root_dir to exist --- it's just a sanity check it does on the remotes= keyword.
97+
# In normal (local) builds, this will be the case, since the Makefiles will have unpacked the standard
98+
# libraries. However, on CI we do this thing where we actually build docs in a clean worktree, just
99+
# unpacking the `usr/` directory from the main build, and the unpacked stdlibs will be missing, and this
100+
# will cause Documenter to throw an error. However, we don't _actually_ need the source files of the standard
101+
# libraries to be present, so we just generate empty root directories to satisfy the check in Documenter.
102+
isdir(package_root_dir) || mkpath(package_root_dir)
103+
package_root_dir => (remote, package_sha)
104+
end
105+
Dict(remotes_list)
106+
end
107+
45108
# Check if we are building a PDF
46109
const render_pdf = "pdf" in ARGS
47110

@@ -299,6 +362,8 @@ else
299362
collapselevel = 1,
300363
sidebar_sitename = false,
301364
ansicolor = true,
365+
size_threshold = 800 * 2^10, # 800 KiB
366+
size_threshold_warn = 200 * 2^10, # the manual has quite a few large pages, so we warn at 200+ KiB only
302367
)
303368
end
304369

@@ -310,12 +375,12 @@ makedocs(
310375
doctest = ("doctest=fix" in ARGS) ? (:fix) : ("doctest=only" in ARGS) ? (:only) : ("doctest=true" in ARGS) ? true : false,
311376
linkcheck = "linkcheck=true" in ARGS,
312377
linkcheck_ignore = ["https://bugs.kde.org/show_bug.cgi?id=136779"], # fails to load from nanosoldier?
313-
strict = true,
314378
checkdocs = :none,
315379
format = format,
316380
sitename = "The Julia Language",
317381
authors = "The Julia Project",
318382
pages = PAGES,
383+
remotes = documenter_stdlib_remotes,
319384
)
320385

321386
# Update URLs to external stdlibs (JuliaLang/julia#43199)

‎stdlib/Dates/docs/src/index.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,3 @@
1-
```@meta
2-
EditURL = "https://github.com/JuliaLang/julia/blob/master/stdlib/Dates/docs/src/index.md"
3-
```
4-
51
# Dates
62

73
```@meta

0 commit comments

Comments
 (0)