Merge pull request #35 from arhik/main

Documentation deployment experiment

Author: arhik

README.md

@@ -1,9 +1,9 @@
 # WGPUCompute
 
-[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://arhik.github.io/WGPUCompute.jl/stable/)
-[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://arhik.github.io/WGPUCompute.jl/dev/)
-[![Build Status](https://github.com/arhik/WGPUCompute.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/arhik/WGPUCompute.jl/actions/workflows/CI.yml?query=branch%3Amain)
-[![Coverage](https://codecov.io/gh/arhik/WGPUCompute.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/arhik/WGPUCompute.jl)
+[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://JuliaWGPU.github.io/WGPUCompute.jl/stable/)
+[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://JuliaWGPU.github.io/WGPUCompute.jl/dev/)
+[![Build Status](https://github.com/JuliaWGPU/WGPUCompute.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/JuliaWGPU/WGPUCompute.jl/actions/workflows/CI.yml?query=branch%3Amain)
+[![Coverage](https://codecov.io/gh/JuliaWGPU/WGPUCompute.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/JuliaWGPU/WGPUCompute.jl)
 
 :warning: This repo is under heavy development.
 

docs/make.jl

@@ -6,11 +6,11 @@ DocMeta.setdocmeta!(WGPUCompute, :DocTestSetup, :(using WGPUCompute); recursive=
 makedocs(;
     modules=[WGPUCompute],
     authors="arhik <[email protected]>",
-    repo="https://github.com/arhik/WGPUCompute.jl/blob/{commit}{path}#{line}",
+    repo="https://github.com/JuliaWGPU/WGPUCompute.jl/blob/{commit}{path}#{line}",
     sitename="WGPUCompute.jl",
     format=Documenter.HTML(;
         prettyurls=get(ENV, "CI", "false") == "true",
-        canonical="https://arhik.github.io/WGPUCompute.jl",
+        canonical="https://JuliaWGPU.github.io/WGPUCompute.jl",
         edit_link="main",
         assets=String[],
     ),
@@ -20,6 +20,6 @@ makedocs(;
 )
 
 deploydocs(;
-    repo="github.com/arhik/WGPUCompute.jl",
+    repo="github.com/JuliaWGPU/WGPUCompute.jl",
     devbranch="main",
 )

docs/src/index.md

@@ -4,7 +4,7 @@ CurrentModule = WGPUCompute
 
 # WGPUCompute
 
-Documentation for [WGPUCompute](https://github.com/arhik/WGPUCompute.jl).
+Documentation for [WGPUCompute](https://github.com/JuliaWGPU/WGPUCompute.jl).
 
 ```@index
 ```

src/ops/cast.jl

@@ -1,5 +1,12 @@
 export cast_kernel, cast
 
+"""
+	cast_kernel(x::WgpuArray{T, N}, out::WgpuArray{S, N}) where {T, S, N}
+This is a compute kernel which casts the `x` array of eltype `T` to eltype `S`.
+Users are not supposed to use this function call from julia. This instead needs to 
+be wrapped with an additional function which uses `@wgpukernel` macro call to
+convert the julia function definition to a equivalent `WGPU` kernel function.
+"""
 function cast_kernel(x::WgpuArray{T, N}, out::WgpuArray{S, N}) where {T, S, N}
 	xdim = workgroupDims.x
 	ydim = workgroupDims.y
@@ -9,9 +16,13 @@ function cast_kernel(x::WgpuArray{T, N}, out::WgpuArray{S, N}) where {T, S, N}
 	out[gId] = S(ceil(x[gId]))
 end	
 
+"""
+	cast(S::DataType, x::WgpuArray{T, N}) where {T, N}
+This is a wrapper function for `cast_kernel` kernel function. This is meant 
+for users to `cast` from regular julia functions.
+"""
 function cast(S::DataType, x::WgpuArray{T, N}) where {T, N}
 	y = WgpuArray{S}(undef, size(x))
 	@wgpukernel launch=true workgroupSizes=(4, 4) workgroupCount=(2, 2) shmem=() cast_kernel(x, y)
 	return y
 end	
-