Skip to content

Commit

Permalink
Include documenter tests in unit tests
Browse files Browse the repository at this point in the history
  • Loading branch information
CiaranOMara committed Nov 27, 2021
1 parent 8fb3c18 commit 1718dde
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 3 deletions.
3 changes: 2 additions & 1 deletion Project.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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"]
6 changes: 5 additions & 1 deletion docs/make.jl
Original file line number Diff line number Diff line change
@@ -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",
Expand Down
10 changes: 9 additions & 1 deletion test/runtests.jl
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit 1718dde

Please sign in to comment.