Merge pull request #70 from JuliaGPU/sd/documentation

documentation

Author: SimonDanisch

docs/make.jl

@@ -3,7 +3,7 @@ using Documenter, GPUArrays
 makedocs()
 
 deploydocs(
-    deps   = Deps.pip("mkdocs", "python-markdown-math"),
+    deps   = Deps.pip("mkdocs", "python-markdown-math", "mkdocs-cinder"),
     repo   = "github.com/JuliaGPU/GPUArrays.jl.git",
     julia  = "0.6",
     osname = "linux"

docs/mkdocs.yml

@@ -3,7 +3,7 @@ repo_url:         https://github.com/JuliaGPU/GPUArrays.jl
 site_description: Abstract GPU Array implementation
 site_author:      JuliaGPU
 
-theme: readthedocs
+theme: cinder
 
 extra_css:
   - assets/Documenter.css

docs/src/index.md

@@ -17,8 +17,9 @@ You can use the reference implementation by using the `GPUArrays.JLArray` type.
 
 The functions that are currently part of the interface:
 
-The low level dim + idx function, with a similar naming as in CUDA (with `*` indicating `(x, y, z)`):
+The low level dim + idx function, with a similar naming scheme as in CUDA:
 ```Julia
+# with * being either of x, y or z
 blockidx_*(state), blockdim_*(state), threadidx_*(state), griddim_*(state)
 # Known in OpenCL as:
 get_group_id,      get_local_size,    get_local_id,       get_num_groups
@@ -27,7 +28,6 @@ get_group_id,      get_local_size,    get_local_id,       get_num_groups
 ```@docs
 gpu_call(f, A::GPUArray, args::Tuple, configuration = length(A))
 
-
 linear_index(state)
 
 global_size(state)
@@ -36,11 +36,9 @@ global_size(state)
 
 @cartesianidx(A, statesym = :state)
 
-
 synchronize_threads(state)
 
-
 device(A::AbstractArray)
-synchronize(A::AbstractArray)
 
+synchronize(A::AbstractArray)
 ```

src/GPUArrays.jl

@@ -19,7 +19,7 @@ include("testsuite/testsuite.jl")
 include("jlbackend.jl")
 include("random.jl")
 
-export GPUArray, gpu_call, thread_blocks_heuristic, global_size
-export linear_index, @linearidx, @cartesianidx, convolution!
+export GPUArray, gpu_call, thread_blocks_heuristic, global_size, synchronize_threads
+export linear_index, @linearidx, @cartesianidx, convolution!, device, synchronize
 
 end # module