Skip to content

Commit 7381533

Browse files
committed
Add autodocs for all libraries [only docs]
1 parent 2e983fe commit 7381533

File tree

16 files changed

+787
-51
lines changed

16 files changed

+787
-51
lines changed

docs/Manifest.toml

Lines changed: 550 additions & 40 deletions
Large diffs are not rendered by default.

docs/Project.toml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,21 @@
11
[deps]
22
BenchmarkTools = "6e4b80f9-dd63-53aa-95a3-0cdb28fa8baf"
3+
CUDA = "052768ef-5323-5732-b1bb-66c8b64840ba"
34
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
45
Literate = "98b081ad-f1c9-55d3-8b20-4c87d4299306"
56
Markdown = "d6f4376e-aef5-505a-96c1-9c027394607a"
67
Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
8+
cuDNN = "02a925ec-e4fe-4b08-9a7e-0d78e3d38ccd"
9+
cuStateVec = "92f7fd98-d22e-4c0d-85a8-6ade11b672fb"
10+
cuTENSOR = "011b41b2-24ef-40a8-b3eb-fa098493e9e1"
11+
cuTensorNet = "448d79b3-4b49-4e06-a5ea-00c62c0dc3db"
12+
13+
[sources]
14+
CUDA = {path = ".."}
15+
cuDNN = {path = "../lib/cudnn"}
16+
cuStateVec = {path = "../lib/custatevec"}
17+
cuTENSOR = {path = "../lib/cutensor"}
18+
cuTensorNet = {path = "../lib/cutensornet"}
719

820
[compat]
921
Documenter = "1"

docs/make.jl

Lines changed: 45 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
using Documenter, Literate
22
using CUDA
3+
using CUDA.CUBLAS, CUDA.CUFFT, CUDA.CUPTI, CUDA.CURAND, CUDA.CUSOLVER, CUDA.CUSPARSE, CUDA.NVML, CUDA.APIUtils
4+
using cuDNN, cuStateVec, cuTENSOR, cuTensorNet
35

46
const src = "https://github.com/JuliaGPU/CUDA.jl"
57
const dst = "https://cuda.juliagpu.org/stable/"
@@ -9,17 +11,23 @@ function main()
911

1012
@info "Building Literate.jl documentation"
1113
cd(@__DIR__) do
12-
Literate.markdown("src/tutorials/introduction.jl", "src/tutorials";
13-
repo_root_url="$src/blob/master/docs")
14-
Literate.markdown("src/tutorials/custom_structs.jl", "src/tutorials";
15-
repo_root_url="$src/blob/master/docs")
16-
Literate.markdown("src/tutorials/performance.jl", "src/tutorials";
17-
repo_root_url="$src/blob/master/docs")
14+
Literate.markdown(
15+
"src/tutorials/introduction.jl", "src/tutorials";
16+
repo_root_url = "$src/blob/master/docs"
17+
)
18+
Literate.markdown(
19+
"src/tutorials/custom_structs.jl", "src/tutorials";
20+
repo_root_url = "$src/blob/master/docs"
21+
)
22+
Literate.markdown(
23+
"src/tutorials/performance.jl", "src/tutorials";
24+
repo_root_url = "$src/blob/master/docs"
25+
)
1826
end
1927
println()
2028

2129
@info "Generating Documenter.jl site"
22-
DocMeta.setdocmeta!(CUDA, :DocTestSetup, :(using CUDA); recursive=true)
30+
DocMeta.setdocmeta!(CUDA, :DocTestSetup, :(using CUDA); recursive = true)
2331
makedocs(
2432
sitename = "CUDA.jl",
2533
authors = "Tim Besard",
@@ -33,13 +41,27 @@ function main()
3341
),
3442
doctest = true,
3543
warnonly = [:missing_docs],
36-
modules = [CUDA],
44+
modules = [
45+
CUDA,
46+
CUBLAS,
47+
CUFFT,
48+
CUPTI,
49+
CURAND,
50+
CUSOLVER,
51+
CUSPARSE,
52+
NVML,
53+
APIUtils,
54+
cuDNN,
55+
cuStateVec,
56+
cuTENSOR,
57+
cuTensorNet,
58+
],
3759
pages = Any[
3860
"Home" => "index.md",
3961
"Tutorials" => Any[
4062
"tutorials/introduction.md",
4163
"tutorials/custom_structs.md",
42-
"tutorials/performance.md"
64+
"tutorials/performance.md",
4365
],
4466
"Installation" => Any[
4567
"installation/overview.md",
@@ -67,13 +89,25 @@ function main()
6789
"api/compiler.md",
6890
],
6991
"Library reference" => Any[
70-
"lib/driver.md",
92+
"lib/cublas.md",
93+
"lib/cudadrv.md",
94+
"lib/cudnn.md",
95+
"lib/cufft.md",
96+
"lib/cupti.md",
97+
"lib/curand.md",
98+
"lib/cusolver.md",
99+
"lib/cusparse.md",
100+
"lib/custatevec.md",
101+
"lib/cutensor.md",
102+
"lib/cutensornet.md",
103+
"lib/nvml.md",
104+
"lib/utils.md",
71105
],
72106
"FAQ" => "faq.md",
73107
]
74108
)
75109

76-
if ci
110+
return if ci
77111
@info "Deploying to GitHub"
78112
deploydocs(
79113
repo = "github.com/JuliaGPU/CUDA.jl.git",

docs/src/lib/cublas.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# CUBLAS
2+
3+
## Public
4+
5+
```@autodocs
6+
Modules = [CUBLAS]
7+
Private = false
8+
```
9+
10+
## Private
11+
12+
```@autodocs
13+
Modules = [CUBLAS]
14+
Public = false
15+
```
File renamed without changes.

docs/src/lib/cudnn.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# cuDNN
2+
3+
## Public
4+
5+
```@autodocs
6+
Modules = [cuDNN]
7+
Private = false
8+
```
9+
10+
## Private
11+
12+
```@autodocs
13+
Modules = [cuDNN]
14+
Public = false
15+
```

docs/src/lib/cufft.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# CUFFT
2+
3+
## Public
4+
5+
```@autodocs
6+
Modules = [CUFFT]
7+
Private = false
8+
```
9+
10+
## Private
11+
12+
```@autodocs
13+
Modules = [CUFFT]
14+
Public = false
15+
```

docs/src/lib/cupti.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# CUPTI
2+
3+
## Public
4+
5+
```@autodocs
6+
Modules = [CUPTI]
7+
Private = false
8+
```
9+
10+
## Private
11+
12+
```@autodocs
13+
Modules = [CUPTI]
14+
Public = false
15+
```

docs/src/lib/curand.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# CURAND
2+
3+
## Public
4+
5+
```@autodocs
6+
Modules = [CURAND]
7+
Private = false
8+
```
9+
10+
## Private
11+
12+
```@autodocs
13+
Modules = [CURAND]
14+
Public = false
15+
```

docs/src/lib/cusolver.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# CUSOLVER
2+
3+
## Public
4+
5+
```@autodocs
6+
Modules = [CUSOLVER]
7+
Private = false
8+
```
9+
10+
## Private
11+
12+
```@autodocs
13+
Modules = [CUSOLVER]
14+
Public = false
15+
```

0 commit comments

Comments
 (0)