Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Run doctests when building docs #203

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
run doctests when building docs
schillic committed Nov 24, 2024
commit 09861c6db799fe7da0ff3735668d84ef1676cef1
10 changes: 10 additions & 0 deletions docs/Project.toml
Original file line number Diff line number Diff line change
@@ -1,13 +1,23 @@
[deps]
DisplayAs = "0b91fe84-8a4c-11e9-3e1d-67c38462b6d6"
AffineArithmetic = "2e89c364-fad6-56cb-99bd-ebadcd2cf8d2"
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
DynamicPolynomials = "7c1d4256-1411-5781-91ec-d7bc3513ac07"
IntervalArithmetic = "d1acc4aa-44c8-5952-acd4-ba5d80a2a253"
IntervalOptimisation = "c7c68f13-a4a2-5b9a-b424-07d005f8d9d2"
Plots = "91a5bcdd-55d7-5caf-9e0b-520d859cae80"
SDPA = "b9a10b5b-afa4-512f-a053-bb3d8080febc"
SumOfSquares = "4b9e565b-77fc-50a5-a571-1244f986bda1"
TaylorModels = "314ce334-5f6e-57ae-acf6-00b6e903104a"

[compat]
AffineArithmetic = "0.2"
DisplayAs = "0.1"
Documenter = "1"
DynamicPolynomials = "0.3 - 0.5, =0.5"
IntervalArithmetic = "=0.20.9" # new versions require updates and are incompatible with dependencies
IntervalOptimisation = "0.4"
Plots = "1"
SDPA = "0.2 - 0.6"
SumOfSquares = "0.3.6 - 0.7"
TaylorModels = "0.3 - 0.7"
1 change: 0 additions & 1 deletion docs/init.jl

This file was deleted.

4 changes: 2 additions & 2 deletions docs/make.jl
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
using Documenter, RangeEnclosures
using IntervalOptimisation, SumOfSquares, SDPA, TaylorModels

include("init.jl")
DocMeta.setdocmeta!(RangeEnclosures, :DocTestSetup, :(using RangeEnclosures); recursive=true)

makedocs(; sitename="RangeEnclosures.jl",
modules=[RangeEnclosures],
format=Documenter.HTML(; prettyurls=get(ENV, "CI", nothing) == "true",
assets=["assets/aligned.css"]),
doctest=false,
pagesonly=true,
pages=["Home" => "index.md",
"Tutorial" => "tutorial.md",
2 changes: 0 additions & 2 deletions test/Project.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
[deps]
AffineArithmetic = "2e89c364-fad6-56cb-99bd-ebadcd2cf8d2"
Aqua = "4c88cf16-eb10-579e-8560-4a9242c79595"
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
DynamicPolynomials = "7c1d4256-1411-5781-91ec-d7bc3513ac07"
IntervalOptimisation = "c7c68f13-a4a2-5b9a-b424-07d005f8d9d2"
SDPA = "b9a10b5b-afa4-512f-a053-bb3d8080febc"
@@ -12,7 +11,6 @@ Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
[compat]
AffineArithmetic = "0.2"
Aqua = "0.8.9"
Documenter = "0.27, 1"
# DynamicPolynomials v0.6 leads to conflict with PolyJuMP, which requires IntervalArithmetic v0.22
DynamicPolynomials = "0.3 - 0.5, =0.5"
IntervalOptimisation = "0.4.1"
7 changes: 0 additions & 7 deletions test/runtests.jl
Original file line number Diff line number Diff line change
@@ -12,11 +12,4 @@ available_solvers = (NaturalEnclosure(),
include("univariate.jl")
include("multivariate.jl")
include("paper.jl")

using Documenter
include("../docs/init.jl")
@testset "doctests" begin
doctest(RangeEnclosures)
end

include("Aqua.jl")