Skip to content

Commit 0ab0b7a

Browse files
maleadtmaleadt
authored
Add documentation. (#459)
1 parent dfb6e01 commit 0ab0b7a

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

72 files changed

+6300
-480
lines changed

‎docs/Manifest.toml

Lines changed: 188 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,93 +1,261 @@
11
# This file is machine-generated - editing it directly is not advised
22

3+
[[ANSIColoredPrinters]]
4+
git-tree-sha1 = "574baf8110975760d391c710b6341da1afa48d8c"
5+
uuid = "a4c015fc-c6ff-483c-b24f-f7ea428134e9"
6+
version = "0.0.1"
7+
8+
[[AbstractTrees]]
9+
git-tree-sha1 = "2d9c9a55f9c93e8887ad391fbae72f8ef55e1177"
10+
uuid = "1520ce14-60c1-5f80-bbc7-55ef81b5835c"
11+
version = "0.4.5"
12+
13+
[[ArgTools]]
14+
uuid = "0dad84c5-d112-42e6-8d28-ef12dabb789f"
15+
version = "1.1.1"
16+
17+
[[Artifacts]]
18+
uuid = "56f22d72-fd6d-98f1-02f0-08ddc0907c33"
19+
320
[[Base64]]
421
uuid = "2a0f44e3-6c83-55bd-87e4-b1978d98bd5f"
522

23+
[[CodecZlib]]
24+
deps = ["TranscodingStreams", "Zlib_jll"]
25+
git-tree-sha1 = "bce6804e5e6044c6daab27bb533d1295e4a2e759"
26+
uuid = "944b1d66-785c-5afd-91f1-9de20f533193"
27+
version = "0.7.6"
28+
629
[[Dates]]
730
deps = ["Printf"]
831
uuid = "ade2ca70-3891-5945-98fb-dc099432e06a"
932

10-
[[Distributed]]
11-
deps = ["Random", "Serialization", "Sockets"]
12-
uuid = "8ba89e20-285c-5b6f-9357-94700520ee1b"
13-
1433
[[DocStringExtensions]]
15-
deps = ["LibGit2", "Markdown", "Pkg", "Test"]
16-
git-tree-sha1 = "88bb0edb352b16608036faadcc071adda068582a"
34+
deps = ["LibGit2"]
35+
git-tree-sha1 = "2fb1e02f2b635d0845df5d7c167fec4dd739b00d"
1736
uuid = "ffbed154-4ef7-542d-bbb7-c09d3a79fcae"
18-
version = "0.8.1"
37+
version = "0.9.3"
1938

2039
[[Documenter]]
21-
deps = ["Base64", "Dates", "DocStringExtensions", "InteractiveUtils", "JSON", "LibGit2", "Logging", "Markdown", "REPL", "Test", "Unicode"]
22-
git-tree-sha1 = "395fa1554c69735802bba37d9e7d9586fd44326c"
40+
deps = ["ANSIColoredPrinters", "AbstractTrees", "Base64", "CodecZlib", "Dates", "DocStringExtensions", "Downloads", "Git", "IOCapture", "InteractiveUtils", "JSON", "LibGit2", "Logging", "Markdown", "MarkdownAST", "Pkg", "PrecompileTools", "REPL", "RegistryInstances", "SHA", "TOML", "Test", "Unicode"]
41+
git-tree-sha1 = "5a1ee886566f2fa9318df1273d8b778b9d42712d"
2342
uuid = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
24-
version = "0.24.11"
43+
version = "1.7.0"
44+
45+
[[Downloads]]
46+
deps = ["ArgTools", "FileWatching", "LibCURL", "NetworkOptions"]
47+
uuid = "f43a241f-c20a-4ad4-852c-f6b1247861c6"
48+
version = "1.6.0"
49+
50+
[[Expat_jll]]
51+
deps = ["Artifacts", "JLLWrappers", "Libdl"]
52+
git-tree-sha1 = "1c6317308b9dc757616f0b5cb379db10494443a7"
53+
uuid = "2e619515-83b5-522b-bb60-26c02a35a201"
54+
version = "2.6.2+0"
55+
56+
[[FileWatching]]
57+
uuid = "7b1f6079-737a-58dc-b8bc-7a2ca5c1b5ee"
58+
59+
[[Git]]
60+
deps = ["Git_jll"]
61+
git-tree-sha1 = "04eff47b1354d702c3a85e8ab23d539bb7d5957e"
62+
uuid = "d7ba0133-e1db-5d97-8f8c-041e4b3a1eb2"
63+
version = "1.3.1"
64+
65+
[[Git_jll]]
66+
deps = ["Artifacts", "Expat_jll", "JLLWrappers", "LibCURL_jll", "Libdl", "Libiconv_jll", "OpenSSL_jll", "PCRE2_jll", "Zlib_jll"]
67+
git-tree-sha1 = "d18fb8a1f3609361ebda9bf029b60fd0f120c809"
68+
uuid = "f8c6e375-362e-5223-8a59-34ff63f689eb"
69+
version = "2.44.0+2"
70+
71+
[[IOCapture]]
72+
deps = ["Logging", "Random"]
73+
git-tree-sha1 = "b6d6bfdd7ce25b0f9b2f6b3dd56b2673a66c8770"
74+
uuid = "b5f81e59-6552-4d32-b1f0-c071b021bf89"
75+
version = "0.2.5"
2576

2677
[[InteractiveUtils]]
2778
deps = ["Markdown"]
2879
uuid = "b77e0a4c-d291-57a0-90e8-8db25a27a240"
2980

81+
[[JLLWrappers]]
82+
deps = ["Artifacts", "Preferences"]
83+
git-tree-sha1 = "f389674c99bfcde17dc57454011aa44d5a260a40"
84+
uuid = "692b3bcd-3c85-4b1f-b108-f13ce0eb3210"
85+
version = "1.6.0"
86+
3087
[[JSON]]
3188
deps = ["Dates", "Mmap", "Parsers", "Unicode"]
32-
git-tree-sha1 = "b34d7cef7b337321e97d22242c3c2b91f476748e"
89+
git-tree-sha1 = "31e996f0a15c7b280ba9f76636b3ff9e2ae58c9a"
3390
uuid = "682c06a0-de6a-54ab-a142-c8b1cf79cde6"
34-
version = "0.21.0"
91+
version = "0.21.4"
92+
93+
[[LazilyInitializedFields]]
94+
git-tree-sha1 = "8f7f3cabab0fd1800699663533b6d5cb3fc0e612"
95+
uuid = "0e77f7df-68c5-4e49-93ce-4cd80f5598bf"
96+
version = "1.2.2"
97+
98+
[[LibCURL]]
99+
deps = ["LibCURL_jll", "MozillaCACerts_jll"]
100+
uuid = "b27032c2-a3e7-50c8-80cd-2d36dbcbfd21"
101+
version = "0.6.4"
102+
103+
[[LibCURL_jll]]
104+
deps = ["Artifacts", "LibSSH2_jll", "Libdl", "MbedTLS_jll", "Zlib_jll", "nghttp2_jll"]
105+
uuid = "deac9b47-8bc7-5906-a0fe-35ac56dc84c0"
106+
version = "8.4.0+0"
35107

36108
[[LibGit2]]
37-
deps = ["Printf"]
109+
deps = ["Base64", "LibGit2_jll", "NetworkOptions", "Printf", "SHA"]
38110
uuid = "76f85450-5226-5b5a-8eaa-529ad045b433"
39111

112+
[[LibGit2_jll]]
113+
deps = ["Artifacts", "LibSSH2_jll", "Libdl", "MbedTLS_jll"]
114+
uuid = "e37daf67-58a4-590a-8e99-b0245dd2ffc5"
115+
version = "1.6.4+0"
116+
117+
[[LibSSH2_jll]]
118+
deps = ["Artifacts", "Libdl", "MbedTLS_jll"]
119+
uuid = "29816b5a-b9ab-546f-933c-edad1886dfa8"
120+
version = "1.11.0+1"
121+
40122
[[Libdl]]
41123
uuid = "8f399da3-3557-5675-b5ff-fb832c97cbdb"
42124

125+
[[Libiconv_jll]]
126+
deps = ["Artifacts", "JLLWrappers", "Libdl"]
127+
git-tree-sha1 = "f9557a255370125b405568f9767d6d195822a175"
128+
uuid = "94ce4f54-9a6c-5748-9c1c-f9c7231a4531"
129+
version = "1.17.0+0"
130+
43131
[[Logging]]
44132
uuid = "56ddb016-857b-54e1-b83d-db4d58db5568"
45133

46134
[[Markdown]]
47135
deps = ["Base64"]
48136
uuid = "d6f4376e-aef5-505a-96c1-9c027394607a"
49137

138+
[[MarkdownAST]]
139+
deps = ["AbstractTrees", "Markdown"]
140+
git-tree-sha1 = "465a70f0fc7d443a00dcdc3267a497397b8a3899"
141+
uuid = "d0879d2d-cac2-40c8-9cee-1863dc0c7391"
142+
version = "0.1.2"
143+
144+
[[MbedTLS_jll]]
145+
deps = ["Artifacts", "Libdl"]
146+
uuid = "c8ffd9c3-330d-5841-b78e-0817d7145fa1"
147+
version = "2.28.2+1"
148+
50149
[[Mmap]]
51150
uuid = "a63ad114-7e13-5084-954f-fe012c677804"
52151

152+
[[MozillaCACerts_jll]]
153+
uuid = "14a3606d-f60d-562e-9121-12d972cd8159"
154+
version = "2023.1.10"
155+
156+
[[NetworkOptions]]
157+
uuid = "ca575930-c2e3-43a9-ace4-1e988b2c1908"
158+
version = "1.2.0"
159+
160+
[[OpenSSL_jll]]
161+
deps = ["Artifacts", "JLLWrappers", "Libdl"]
162+
git-tree-sha1 = "a028ee3cb5641cccc4c24e90c36b0a4f7707bdf5"
163+
uuid = "458c3c95-2e84-50aa-8efc-19380b2a3a95"
164+
version = "3.0.14+0"
165+
166+
[[PCRE2_jll]]
167+
deps = ["Artifacts", "Libdl"]
168+
uuid = "efcefdf7-47ab-520b-bdef-62a2eaa19f15"
169+
version = "10.42.0+1"
170+
53171
[[Parsers]]
54-
deps = ["Dates", "Test"]
55-
git-tree-sha1 = "f0abb338b4d00306500056a3fd44c221b8473ef2"
172+
deps = ["Dates", "PrecompileTools", "UUIDs"]
173+
git-tree-sha1 = "8489905bcdbcfac64d1daa51ca07c0d8f0283821"
56174
uuid = "69de0a69-1ddd-5017-9359-2bf0b02dc9f0"
57-
version = "1.0.4"
175+
version = "2.8.1"
58176

59177
[[Pkg]]
60-
deps = ["Dates", "LibGit2", "Libdl", "Logging", "Markdown", "Printf", "REPL", "Random", "SHA", "UUIDs"]
178+
deps = ["Artifacts", "Dates", "Downloads", "FileWatching", "LibGit2", "Libdl", "Logging", "Markdown", "Printf", "REPL", "Random", "SHA", "Serialization", "TOML", "Tar", "UUIDs", "p7zip_jll"]
61179
uuid = "44cfe95a-1eb2-52ea-b672-e2afdf69b78f"
180+
version = "1.10.0"
181+
182+
[[PrecompileTools]]
183+
deps = ["Preferences"]
184+
git-tree-sha1 = "5aa36f7049a63a1528fe8f7c3f2113413ffd4e1f"
185+
uuid = "aea7be01-6a6a-4083-8856-8a6e6704d82a"
186+
version = "1.2.1"
187+
188+
[[Preferences]]
189+
deps = ["TOML"]
190+
git-tree-sha1 = "9306f6085165d270f7e3db02af26a400d580f5c6"
191+
uuid = "21216c6a-2e73-6563-6e65-726566657250"
192+
version = "1.4.3"
62193

63194
[[Printf]]
64195
deps = ["Unicode"]
65196
uuid = "de0858da-6303-5e67-8744-51eddeeeb8d7"
66197

67198
[[REPL]]
68-
deps = ["InteractiveUtils", "Markdown", "Sockets"]
199+
deps = ["InteractiveUtils", "Markdown", "Sockets", "Unicode"]
69200
uuid = "3fa0cd96-eef1-5676-8a61-b3b8758bbffb"
70201

71202
[[Random]]
72-
deps = ["Serialization"]
203+
deps = ["SHA"]
73204
uuid = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"
74205

206+
[[RegistryInstances]]
207+
deps = ["LazilyInitializedFields", "Pkg", "TOML", "Tar"]
208+
git-tree-sha1 = "ffd19052caf598b8653b99404058fce14828be51"
209+
uuid = "2792f1a3-b283-48e8-9a74-f99dce5104f3"
210+
version = "0.1.0"
211+
75212
[[SHA]]
76213
uuid = "ea8e919c-243c-51af-8825-aaa63cd721ce"
214+
version = "0.7.0"
77215

78216
[[Serialization]]
79217
uuid = "9e88b42a-f829-5b0c-bbe9-9e923198166b"
80218

81219
[[Sockets]]
82220
uuid = "6462fe0b-24de-5631-8697-dd941f90decc"
83221

222+
[[TOML]]
223+
deps = ["Dates"]
224+
uuid = "fa267f1f-6049-4f14-aa54-33bafae1ed76"
225+
version = "1.0.3"
226+
227+
[[Tar]]
228+
deps = ["ArgTools", "SHA"]
229+
uuid = "a4e569a6-e804-4fa4-b0f3-eef7a1d5b13e"
230+
version = "1.10.0"
231+
84232
[[Test]]
85-
deps = ["Distributed", "InteractiveUtils", "Logging", "Random"]
233+
deps = ["InteractiveUtils", "Logging", "Random", "Serialization"]
86234
uuid = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
87235

236+
[[TranscodingStreams]]
237+
git-tree-sha1 = "e84b3a11b9bece70d14cce63406bbc79ed3464d2"
238+
uuid = "3bb67fe8-82b1-5028-8e26-92a6c54297fa"
239+
version = "0.11.2"
240+
88241
[[UUIDs]]
89242
deps = ["Random", "SHA"]
90243
uuid = "cf7118a7-6976-5b1a-9a39-7adc72f591a4"
91244

92245
[[Unicode]]
93246
uuid = "4ec0a83e-493e-50e2-b9ac-8f72acf5a8f5"
247+
248+
[[Zlib_jll]]
249+
deps = ["Libdl"]
250+
uuid = "83775a58-1f1d-513f-b197-d71354ab007a"
251+
version = "1.2.13+1"
252+
253+
[[nghttp2_jll]]
254+
deps = ["Artifacts", "Libdl"]
255+
uuid = "8e850ede-7688-5339-a07c-302acd2aaf8d"
256+
version = "1.52.0+1"
257+
258+
[[p7zip_jll]]
259+
deps = ["Artifacts", "Libdl"]
260+
uuid = "3f19e933-33d8-53b3-aaab-bd5110c3b7a0"
261+
version = "17.4.0+2"

‎docs/Project.toml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,5 @@
11
[deps]
22
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
3+
4+
[compat]
5+
Documenter = "1.7"

‎docs/make.jl

Lines changed: 57 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,62 @@
11
using Documenter, LLVM
22

3-
makedocs(
4-
modules = [LLVM],
5-
format = Documenter.HTML(prettyurls = get(ENV, "CI", nothing) == "true"),
6-
sitename = "LLVM.jl",
7-
pages = [
8-
"Home" => "index.md",
9-
"Manual" => [
10-
"man/usage.md",
11-
"man/troubleshooting.md"
3+
function main()
4+
ci = get(ENV, "CI", "") == "true"
5+
6+
makedocs(
7+
sitename = "LLVM.jl",
8+
authors = "Tim Besard",
9+
format = Documenter.HTML(
10+
# Use clean URLs on CI
11+
prettyurls = ci
12+
),
13+
modules = [LLVM],
14+
checkdocs_ignored_modules = [LLVM.API],
15+
pages = [
16+
"Home" => "index.md",
17+
"Usage" => [
18+
"man/essentials.md",
19+
"man/types.md",
20+
"man/values.md",
21+
"man/modules.md",
22+
"man/functions.md",
23+
"man/blocks.md",
24+
"man/instructions.md",
25+
"man/metadata.md",
26+
"man/analyses.md",
27+
"man/transforms.md",
28+
"man/codegen.md",
29+
"man/execution.md",
30+
"man/interop.md",
31+
],
32+
"API reference" => [
33+
"lib/essentials.md",
34+
"lib/types.md",
35+
"lib/values.md",
36+
"lib/modules.md",
37+
"lib/functions.md",
38+
"lib/blocks.md",
39+
"lib/instructions.md",
40+
"lib/metadata.md",
41+
"lib/analyses.md",
42+
"lib/transforms.md",
43+
"lib/codegen.md",
44+
"lib/execution.md",
45+
"lib/interop.md",
46+
]
1247
],
13-
"Library" => [
14-
"lib/api.md",
15-
"lib/interop.md"
48+
doctest = true,
49+
doctestfilters = [
50+
r"0x[0-9a-f]+", # pointer values
51+
r"@julia_\w+_\d+" # function names in generated code
1652
]
17-
],
18-
doctest = true
19-
)
53+
)
54+
55+
if ci
56+
deploydocs(
57+
repo = "github.com/maleadt/LLVM.jl.git"
58+
)
59+
end
60+
end
2061

21-
deploydocs(
22-
repo = "github.com/maleadt/LLVM.jl.git"
23-
)
62+
isinteractive() || main()

0 commit comments

Comments
 (0)