Skip to content

Commit a465d3d

Browse files
committed
docs: now builds only exported functions. removed _turbo!_ from exports.
1 parent 7646d6b commit a465d3d

5 files changed

Lines changed: 18 additions & 8 deletions

File tree

Project.toml

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
11
name = "LoopVectorization"
22
uuid = "bdcacae8-1622-11e9-2a5c-532679323890"
3-
version = "0.12.172"
43
authors = ["Chris Elrod <elrodc@gmail.com>"]
4+
version = "0.12.172"
55

66
[deps]
77
ArrayInterface = "4fba245c-0d91-5ea0-9b3e-6abc04ee57a9"
88
CPUSummary = "2a0fbf3d-bb9c-48f3-b0a9-814d99fd7ab9"
99
ChainRulesCore = "d360d2e6-b24c-11e9-a2a3-2a2ae2dbcce4"
1010
CloseOpenIntervals = "fb6a15b2-703c-40df-9091-08a04967cfa9"
1111
DocStringExtensions = "ffbed154-4ef7-542d-bbb7-c09d3a79fcae"
12+
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
1213
ForwardDiff = "f6369f11-7733-5829-9624-2563aa707210"
1314
HostCPUFeatures = "3e5b6fbb-0976-4d2c-9146-d79de83f2fb0"
1415
IfElse = "615f187c-cbe4-4ef1-ba3b-2fcf58d6d173"
@@ -29,8 +30,8 @@ VectorizationBase = "3d5dd08c-fd9d-11e8-17fa-ed2836048c2f"
2930
[weakdeps]
3031
ChainRulesCore = "d360d2e6-b24c-11e9-a2a3-2a2ae2dbcce4"
3132
ForwardDiff = "f6369f11-7733-5829-9624-2563aa707210"
32-
SpecialFunctions = "276daf66-3868-5448-9aa4-cd146d93841b"
3333
NNlib = "872c559c-99b0-510c-b3b7-b6c96a88d5cd"
34+
SpecialFunctions = "276daf66-3868-5448-9aa4-cd146d93841b"
3435

3536
[extensions]
3637
ForwardDiffExt = ["ChainRulesCore", "ForwardDiff", "NNlib"]
@@ -63,4 +64,4 @@ julia = "1.10"
6364

6465
[extras]
6566
ForwardDiff = "f6369f11-7733-5829-9624-2563aa707210"
66-
NNlib = "872c559c-99b0-510c-b3b7-b6c96a88d5cd"
67+
NNlib = "872c559c-99b0-510c-b3b7-b6c96a88d5cd"

docs/make.jl

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@ makedocs(;
1111
"examples/matrix_multiplication.md",
1212
"examples/array_interface.md",
1313
"examples/matrix_vector_ops.md",
14-
"examples/dot_product.md",
1514
"examples/datetime_arrays.md",
1615
"examples/special_functions.md",
1716
"examples/sum_of_squared_error.md",
@@ -31,7 +30,8 @@ makedocs(;
3130
],
3231
# repo="https://github.com/JuliaSIMD/LoopVectorization.jl/blob/{commit}{path}#L{line}",
3332
sitename = "LoopVectorization.jl",
34-
authors = "Chris Elrod"
33+
authors = "Chris Elrod",
34+
checkdocs=:exports,
3535
# assets=[],
3636
)
3737

docs/src/api.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# API reference
22

3+
```@docs
4+
LoopVectorization
5+
```
6+
37
## Macros
48

59
```@docs
@@ -12,6 +16,8 @@
1216
```@docs
1317
vmap
1418
vmap!
19+
vmapt
20+
vmapt!
1521
vmapnt
1622
vmapnt!
1723
vmapntt
@@ -27,7 +33,12 @@ LoopVectorization.vfilter!
2733

2834
## `reduce`-like constructs
2935
```@docs
36+
vsum
3037
vreduce
3138
vmapreduce
3239
```
3340

41+
## Operators
42+
```@docs
43+
44+
```

docs/src/index.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,5 +30,3 @@ Pages = [
3030
]
3131
Depth = 1
3232
```
33-
34-

src/LoopVectorization.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ if isdefined(Base, :Experimental) &&
2525
@eval Base.Experimental.@max_methods 1
2626
end
2727
export LowDimArray,
28-
static, stridedpointer, *ˡ, _turbo_!, tanh_fast, sigmoid_fast
28+
static, stridedpointer, *ˡ, tanh_fast, sigmoid_fast
2929

3030
using ArrayInterface: UpTri, LoTri
3131
using Static: StaticInt, gt, static, Zero, One, reduce_tup

0 commit comments

Comments
 (0)