Skip to content

Commit

Permalink
Turn on doctests
Browse files Browse the repository at this point in the history
  • Loading branch information
abhro committed May 10, 2024
1 parent b9e4625 commit 04ac73b
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 7 deletions.
4 changes: 2 additions & 2 deletions contrib/generate_exports.jl
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@ sources = first.(splitext.(filter(x->!startswith(x, "t_") && !startswith(x, "erf
exports = "export " * join(sources, ", ")

open(OUTPUT, "w") do f
println(f, "# Auto-generated by $(joinpath(basename(@__DIR__()), basename(@__FILE__))). Do not edit!\n")
println(f, exports)
println(f, "# Auto-generated by $(joinpath(basename(@__DIR__()), basename(@__FILE__))). Do not edit!\n")
println(f, exports)
end

format(OUTPUT, BlueStyle())
9 changes: 6 additions & 3 deletions docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,17 @@ using Documenter, ERFA

include("pages.jl")

makedocs(format = Documenter.HTML(prettyurls = get(ENV, "CI", nothing) == "true",
makedocs(
format = Documenter.HTML(
prettyurls = get(ENV, "CI", nothing) == "true",
),
sitename = "ERFA.jl",
authors = "The JuliaAstro Contributors",
pages = pages,
doctest = false,
doctest = true,
)

deploydocs(repo = "github.com/JuliaAstro/ERFA.jl.git",
deploydocs(
repo = "github.com/JuliaAstro/ERFA.jl.git",
target = "build",
)
4 changes: 2 additions & 2 deletions docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,14 @@ Julia wrapper for [liberfa](https://github.com/liberfa/erfa).
Installation
------------

```julia
```julia-repl
julia> import Pkg; Pkg.add("ERFA")
```

Example
-------

```julia
```jldoctest
julia> using ERFA
julia> u1, u2 = dtf2d("UTC", 2010, 7, 24, 11, 18, 7.318)
Expand Down

0 comments on commit 04ac73b

Please sign in to comment.