setup Documenter.jl

.travis.yml

@@ -15,7 +15,7 @@ git:
 ## (tests will run but not make your overall status red)
 matrix:
   allow_failures:
-  - julia: nightly
+    - julia: nightly
 
 ## uncomment and modify the following lines to manually install system packages
 #addons:
@@ -31,5 +31,7 @@ matrix:
 after_success:
   # push coverage results to Coveralls
   - julia -e 'cd(Pkg.dir("ReferenceTests")); Pkg.add("Coverage"); using Coverage; Coveralls.submit(Coveralls.process_folder())'
+  - julia -e 'Pkg.add("Documenter")'
+  - julia -e 'cd(Pkg.dir("ReferenceTests")); include(joinpath("docs", "make.jl"))'
   # push coverage results to Codecov
   #  - julia -e 'cd(Pkg.dir("ReferenceTests")); Pkg.add("Coverage"); using Coverage; Codecov.submit(Codecov.process_folder())'

docs/.gitignore

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

docs/make.jl

@@ -1,3 +1,21 @@
 using Documenter, ReferenceTests
 
-makedocs()
+makedocs(
+    modules = [ReferenceTests],
+    clean = false,
+    format = :html,
+    sitename = "ReferenceTests.jl",
+    authors = "Christof Stocker",
+    linkcheck = !("skiplinks" in ARGS),
+    pages = Any[
+        "Home" => "index.md"
+    ],
+    html_prettyurls = !("local" in ARGS),
+)
+
+deploydocs(
+    repo = "github.com/Evizero/ReferenceTests.jl.git",
+    target = "build",
+    deps = nothing,
+    make = nothing,
+)

src/utils.jl

@@ -12,6 +12,8 @@ common example of such would be a custom `Base.show` method.
 # Examples
 
 ```jldoctest
+julia> using ReferenceTests
+
 julia> @io2str print(::IO, "Hello World")
 "Hello World"
 
@@ -64,8 +66,13 @@ Make sure that `ex` is evaluated while `Base.have_color` is set
 to `true`. The original value of `Base.have_color` will be
 restored afterwards.
 
-This macro is particularily useful for CI, where `julia` is
-executed without the `--color=yes` argument by default.
+This macro is particularily useful for CI, where it is not
+unusual that  `julia` is executed without the `--color=yes`
+argument by default.
+
+```julia
+@withcolor print_with_color(:green, "foo")
+```
 """
 macro withcolor(expr)
     :(withcolor(()->$(esc(expr))))