Include documenter tests in unit tests

Author: CiaranOMara

Project.toml

@@ -17,7 +17,8 @@ TranscodingStreams = "0.9.5"
 julia = "1.3"
 
 [extras]
+Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
 
 [targets]
-test = ["Test"]
+test = ["Documenter", "Test"]

docs/make.jl

@@ -1,17 +1,21 @@
 using Pkg
 using Documenter, Indexes
 
+DocMeta.setdocmeta!(Indexes, :DocTestSetup, :(using Indexes); recursive=true)
+
 makedocs(
     format = Documenter.HTML(
         edit_link = "develop"
     ),
     modules = [Indexes],
+    checkdocs = :all,
+    linkcheck = true,
     sitename = "Indexes.jl",
+    authors = replace(join(Pkg.TOML.parsefile("Project.toml")["authors"], ", "), r" <.*?>" => "" ) * ", The BioJulia Organisation, and other contributors.",
     pages = [
         "Home" => "index.md",
         "API Reference" => "man/api.md"
     ],
-    authors = replace(join(Pkg.TOML.parsefile("Project.toml")["authors"], ", "), r" <.*?>" => "" ) * ", The BioJulia Organisation, and other contributors."
 )
 deploydocs(
     repo = "github.com/BioJulia/Indexes.jl.git",

test/runtests.jl

@@ -1,7 +1,15 @@
 using Test
+using Documenter
+
 using Indexes
 
 @testset "Indexes" begin
     # TODO
     # @test GenomicFeatures.Indexes.Tabix === GenomicFeatures.Indexes.Tabix
-end
+
+
+# Include doctests.
+DocMeta.setdocmeta!(Indexes, :DocTestSetup, :(using Indexes); recursive=true)
+doctest(Indexes; manual = false)
+
+end