Updated documentation to include Space.jl module

docs/make.jl

@@ -5,4 +5,9 @@ Pkg.activate("../")
 using LatticeGPU
 
 makedocs(sitename="LatticeGPU", modules=[LatticeGPU], doctest=true,
+         pages = [
+             "LatticeGPU.jl" => "index.md", 
+             "Space-time" => "space.md",
+             "Groups and algebras" => "groups.md"
+             ], 
          repo = "https://igit.ific.uv.es/alramos/latticegpu.jl")

docs/src/space.md

@@ -0,0 +1,28 @@
+
+# Lattice structure
+
+D-dimensional lattice points are labeled by two ordered integer
+numbers: the point-in-block index ($$b$$ in the figure below) and the
+block index ($$r$$ in the fire below). the routines [`up`](@ref) and
+[`dw`](@ref) allow you to displace to the neighboring points of the
+lattice. 
+![blocks](blocks.png "D dimensional lattice points are labeled by its
+index (a `Tuple` of integers). Given a point (by its index), there are
+routines to jump to neighboring points.")
+
+Directions are numbered fro 1 to D, and then Euclidean time is always
+assumed to be the last coordinate. Planes are also numbered from 1 to
+$$N(N-1)/2$$. The structure [`SpaceParm`](@ref)
+contains the information of the 
+lattice structure and has to be passed as argument to most routines. 
+
+```@docs
+SpaceParm
+up
+dw
+updw
+point_coord
+point_time
+point_index
+point_color
+```