Add Documenter docs (#17)

.travis.yml

@@ -16,3 +16,14 @@ script:
     - if [[ -a .git/shallow ]]; then git fetch --unshallow; fi
     - if [[ `uname` = "Linux" ]]; then TESTCMD='xvfb-run julia'; else TESTCMD='julia'; fi
     - $TESTCMD -e 'using Pkg; Pkg.build(); Pkg.test(coverage=true)'
+
+jobs:
+  include:
+    - stage: "Documentation"
+      julia: 1.3
+      os: linux
+      script:
+        - julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd()));
+                                               Pkg.instantiate()'
+        - julia --project=docs/ docs/make.jl
+      after_success: skip

README.md

@@ -1,7 +1,10 @@
 # Graphics.jl
-A holding place for Base graphics
 
-[![Graphics](http://pkg.julialang.org/badges/Graphics_0.3.svg)](http://pkg.julialang.org/?pkg=Graphics&ver=0.3)
-[![Graphics](http://pkg.julialang.org/badges/Graphics_0.4.svg)](http://pkg.julialang.org/?pkg=Graphics&ver=0.4)
+Graphics.jl is an [abstraction layer](https://en.wikipedia.org/wiki/Abstraction_layer)
+for graphical operations in Julia.
 
-[Julia 0.3 Base.Graphics docs](http://docs.julialang.org/en/release-0.3/stdlib/graphics/).
+[![Graphics](http://pkg.julialang.org/badges/Graphics_1.0.svg)](http://pkg.julialang.org/?pkg=Graphics&ver=1.0)
+
+See the documentation:
+
+[![](https://img.shields.io/badge/docs-stable-blue.svg)](https://JuliaGraphics.github.io/Graphics.jl/stable)

docs/.gitignore

@@ -0,0 +1,2 @@
+build/
+site/

docs/Project.toml

@@ -0,0 +1,5 @@
+[deps]
+Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
+
+[compat]
+Documenter = "0.24"

docs/make.jl

@@ -0,0 +1,13 @@
+using Documenter
+using Graphics
+
+makedocs(
+    sitename = "Graphics",
+    format = Documenter.HTML(prettyurls = get(ENV, "CI", nothing) == "true"),
+    modules = [Graphics],
+    pages = ["index.md", "reference.md"]
+)
+
+deploydocs(
+    repo = "github.com/JuliaGraphics/Graphics.jl.git"
+)

docs/src/index.md

@@ -0,0 +1,12 @@
+# Graphics.jl
+
+Graphics.jl is an [abstraction layer](https://en.wikipedia.org/wiki/Abstraction_layer)
+for graphical operations in Julia.
+Its goal is to allow developers to write graphical programs in a manner independent
+of the particular graphical backend.
+One needs to load a backend package that implements the operations in its API;
+currently, [Cairo.jl](https://github.com/JuliaGraphics/Cairo.jl)
+is the only such backend.
+
+To get an organized overview of the API, try typing `?Graphics` at the Julia REPL.
+You can see the same information in greater detail on the next page.

docs/src/reference.md

@@ -0,0 +1,112 @@
+# Reference
+
+## Geometric primitives
+
+```@docs
+Vec2
+Point
+BoundingBox
+```
+
+## Geometry API
+
+```@docs
+aspect_ratio
+center
+deform
+diagonal
+isinside
+shift
+height
+width
+xmin
+xmax
+ymin
+ymax
+xrange
+yrange
+```
+
+## 2d drawing contexts
+
+```@docs
+GraphicsDevice
+GraphicsContext
+creategc
+getgc
+```
+
+## Coordinate systems
+
+```@docs
+set_coordinates
+reset_transform
+rotate
+scale
+translate
+user_to_device!
+device_to_user!
+user_to_device_distance!
+device_to_user_distance!
+user_to_device
+device_to_user
+```
+
+## Lines
+
+```@docs
+set_line_width
+set_dash
+```
+
+## Colors and painting (drawing attributes)
+
+```@docs
+set_source
+set_source_rgb
+set_source_rgba
+save
+restore
+```
+
+## Clipping
+
+```@docs
+clip
+clip_preserve
+reset_clip
+inner_canvas
+```
+
+## Paths
+
+```@docs
+move_to
+line_to
+rel_line_to
+rel_move_to
+new_path
+new_sub_path
+close_path
+arc
+```
+
+## High-level paths
+
+```@docs
+rectangle
+circle
+polygon
+```
+
+## Fill and stroke
+
+```@docs
+fill
+fill_preserve
+paint
+stroke
+stroke_preserve
+stroke_transformed
+stroke_transformed_preserve
+```