fix warnings in documentation build

Author: vchuravy

docs/make.jl

@@ -7,12 +7,15 @@ makedocs(
         prettyurls = get(ENV, "CI", nothing) == "true"
     ),
     pages = [
-        "Home"    => "index.md",
+        "Home" => "index.md",
         "Writing kernels" => "kernels.md",
-        "Examples"     => [
+        "Examples" => [
             "examples/memcopy.md"
         ],
         "API"          => "api.md",
+        "Extras" => [
+            "extras/unrolling.md"
+        ]
     ],
     doctest = true
 )

docs/src/api.md

@@ -11,4 +11,11 @@
 @synchronize
 ```
 
-## Host interface
+## Host interface
+
+## Internal
+
+```@docs
+KernelAbstractions.Kernel
+KernelAbstractions.partition
+```

docs/src/examples/memcopy.md

@@ -1,11 +1,14 @@
-The first example simple copies memory from `A` to `B`
+# Memcopy
 
+The first example simple copies memory from `A` to `B`
 
 ````@eval
 using Markdown
+using KernelAbstractions
+path = joinpath(dirname(pathof(KernelAbstractions)), "..", "examples/memcopy.jl")
 Markdown.parse("""
 ```julia
-$(read("../../examples/memcopy.jl", String))
+$(read(path, String))
 ```
 """)
-````
+````

docs/src/extras/unrolling.md

@@ -0,0 +1,9 @@
+# Unroll macro
+
+```@meta
+CurrentModule = KernelAbstractions.Extras
+```
+
+```@docs
+@unroll
+```

docs/src/index.md

@@ -47,7 +47,7 @@ all(A .== 2.0)
 !!! danger
     All kernel launches are asynchronous, each kernel produces an event token that
     has to be waited upon, before reading or writing memory that was passed as an
-    argument to the kernel. See [dependencies](@id dependencies) for a full
+    argument to the kernel. See [dependencies](@ref dependencies) for a full
     explanation.
 
 ## Important difference to Julia

docs/src/kernels.md

@@ -3,27 +3,18 @@
 These kernel language constructs are intended to be used as part
 of [`@kernel`](@ref) functions and not outside that context.
 
-```@docs
-@kernel
-```
-
 ## Constant arguments
 
-```@docs
-@const
-```
+[`@Const`](@ref)
 
 ## Indexing
 
-```@docs
-@index
-```
-
+There are several [`@index`](@ref) variants.
 
 ## Local memory, variable lifetime and private memory
 
-```@docs
-@localmem
-@synchronize
-@private
-```
+[`@localmem`](@ref), [`@synchronize`](@ref), [`@private`](@ref)
+
+# Launching kernels
+
+## [Kernel dependencies](@id dependencies)

src/KernelAbstractions.jl

@@ -1,7 +1,7 @@
 module KernelAbstractions
 
 export @kernel
-export @Const, @local, @private, @synchronize, @index
+export @Const, @localmem, @private, @synchronize, @index
 export Device, GPU, CPU, CUDA 
 
 using StaticArrays
@@ -13,6 +13,11 @@ using Requires
 """
 macro kernel end
 
+"""
+   @Const(A)
+"""
+macro Const end
+
 abstract type Event end
 import Base.wait
 

src/extras/extras.jl

@@ -1,5 +1,7 @@
 module Extras
 
 include("loopinfo.jl")
+using .LoopInfo
+export @unroll
 
 end # module