fix docs

.github/workflows/UnitTest.yml

@@ -36,7 +36,7 @@ jobs:
             version: '1'
             arch: x86
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - uses: julia-actions/setup-julia@v1
         with:
           version: ${{ matrix.version }}
@@ -45,14 +45,14 @@ jobs:
       - uses: julia-actions/julia-buildpkg@v1
       - uses: julia-actions/julia-runtest@v1
       - uses: julia-actions/julia-processcoverage@v1
-      - uses: codecov/codecov-action@v2
+      - uses: codecov/codecov-action@v3
         with:
           files: lcov.info
   multithreads:
     name: Julia (threads) 1 - ubuntu-latest - x64 - ${{ github.event_name }}
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - uses: julia-actions/setup-julia@v1
         with:
           version: '1'
@@ -62,6 +62,6 @@ jobs:
       - name: run test
         run: julia --project --code-coverage -t4 -e 'using Pkg; Pkg.test()'
       - uses: julia-actions/julia-processcoverage@v1
-      - uses: codecov/codecov-action@v2
+      - uses: codecov/codecov-action@v3
         with:
           files: lcov.info

.github/workflows/docs.yml

@@ -18,7 +18,7 @@ jobs:
         julia-version: [1]
         os: [ubuntu-latest]
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - uses: julia-actions/setup-julia@latest
         with:
           version: ${{ matrix.julia-version }}

docs/Project.toml

@@ -1,3 +1,5 @@
 [deps]
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
+ImageCore = "a09fc81d-aa75-5fe9-8630-4744c3626534"
 JpegTurbo = "b835a17e-a41a-41e7-81f0-2f016b05efe0"
+TestImages = "5e47fb64-e119-507b-a336-dd2b206d9990"

docs/make.jl

@@ -1,5 +1,11 @@
 using JpegTurbo
 using Documenter
+using ImageCore, TestImages
+
+DocMeta.setdocmeta!(JpegTurbo, :DocTestSetup, :(using JpegTurbo); recursive=true)
+
+# ensure TestImages artifacts are downloaded before running documenter test
+img = testimage("cameraman");
 
 format = Documenter.HTML(
     prettyurls = get(ENV, "CI", nothing) == "true"
@@ -13,7 +19,7 @@ makedocs(;
         "Home" => "index.md",
         "Reference" => "reference.md",
     ],
-    doctest=false, # doctest are run in unit test
+    doctest=true, # doctest are run in unit test
 )
 
 deploydocs(;

src/decode.jl

@@ -24,7 +24,7 @@ Decode the JPEG image as colorant matrix. The source data can be either a filena
 # Examples
 
 ```jldoctest
-julia> using JpegTurbo, TestImages, ImageCore
+julia> using TestImages, ImageCore
 
 julia> filename = testimage("earth", download_only=true);
 

src/encode.jl

@@ -25,7 +25,7 @@ in memory as return value.
 # Examples
 
 ```jldoctest
-julia> using JpegTurbo, TestImages
+julia> using TestImages
 
 julia> img = testimage("cameraman");
 

test/runtests.jl

@@ -10,6 +10,8 @@ using Suppressor
 # ensure TestImages artifacts are downloaded before running documenter test
 testimage("cameraman")
 
+DocMeta.setdocmeta!(JpegTurbo, :DocTestSetup, :(using JpegTurbo); recursive=true)
+
 const tmpdir = mktempdir()
 
 include("testutils.jl")