add running doctests to test suite

Author: hakkelt

test/Project.toml

@@ -1,5 +1,6 @@
 [deps]
 Aqua = "4c88cf16-eb10-579e-8560-4a9242c79595"
+Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
 LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
 Random = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"
 SparseArrays = "2f01184e-e22b-5df5-ae63-d93ebab69eaf"

test/runtests.jl

@@ -19,6 +19,7 @@ using ProximalOperators:
     is_support
 
 using Aqua
+using Documenter
 
 function call_test(f, x::ArrayOrTuple{R}) where R <: Real
     try
@@ -117,6 +118,10 @@ end
     Aqua.test_all(ProximalOperators; ambiguities=false)
 end
 
+@testset "Documentation" begin
+    doctest(ProximalOperators)
+end
+
 @testset "Utilities" begin
     include("test_symmetricpacked.jl")
 end