Skip to content

Commit 7b123cd

Browse files
lbenetdpsanders
authored andcommitted
Update docs deployment (#279)
* Update docs deployment * Fix some problems with doctests * Allow failures in nightly (appveyor)
1 parent 224948b commit 7b123cd

File tree

7 files changed

+39
-19
lines changed

7 files changed

+39
-19
lines changed

.travis.yml

Lines changed: 21 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,16 +12,31 @@ os:
1212
julia:
1313
- 0.7
1414
- 1.0
15+
- 1.1
1516
- nightly
1617

17-
#matrix:
18-
# allow_failures:
19-
# - julia: nightly
18+
matrix:
19+
allow_failures:
20+
- julia: nightly
2021

2122
notifications:
2223
email: false
2324

25+
env:
26+
global:
27+
- DOCUMENTER_DEBUG=true
28+
29+
jobs:
30+
include:
31+
- stage: "Documentation"
32+
julia: 1.1
33+
os: linux
34+
script:
35+
- julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()'
36+
- julia --project=docs/ docs/make.jl
37+
after_success: skip
38+
2439
after_success:
25-
- julia -e 'using Pkg; ps=Pkg.PackageSpec(name="Documenter", version="0.19"); Pkg.add(ps); Pkg.pin(ps)'
26-
- julia -e 'cd(Pkg.dir("IntervalArithmetic")); include(joinpath("docs", "make.jl"))'
27-
- julia -e 'cd(Pkg.dir("IntervalArithmetic")); Pkg.add("Coverage"); using Coverage; Coveralls.submit(Coveralls.process_folder()); Codecov.submit(process_folder())'
40+
- julia -e 'import Pkg; Pkg.add("Coverage"); using Coverage; Coveralls.submit(Coveralls.process_folder())'
41+
42+
sudo: false

appveyor.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@ platform:
1010

1111
# # Uncomment the following lines to allow failures on nightly julia
1212
# # (tests will run but not make your overall status red)
13-
# matrix:
14-
# allow_failures:
15-
# - julia_version: nightly
13+
matrix:
14+
allow_failures:
15+
- julia_version: nightly
1616

1717
branches:
1818
only:

docs/Project.toml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
[deps]
2+
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
3+
IntervalArithmetic = "d1acc4aa-44c8-5952-acd4-ba5d80a2a253"

docs/make.jl

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,9 @@ using Documenter, IntervalArithmetic
22

33
makedocs(
44
modules = [IntervalArithmetic],
5-
format = :html,
5+
format = Documenter.HTML(prettyurls = get(ENV, "CI", nothing) == "true"),
66
sitename = "IntervalArithmetic",
7+
authors = "David P. Sanders and Luis Benet",
78
pages = [
89
"Package" => "index.md",
910
"Interval Arithmetic" => "intro.md",
@@ -19,8 +20,6 @@ makedocs(
1920
deploydocs(
2021
repo = "github.com/JuliaIntervals/IntervalArithmetic.jl.git",
2122
target = "build",
22-
julia = "1.0",
23-
osname = "linux",
2423
deps = nothing,
2524
make = nothing
2625
)

docs/src/decorations.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,10 @@ julia> X = DecoratedInterval(3, 4)
4242
By default, decorations are not displayed. The following turns on display of decorations:
4343
```jldoctest decorations
4444
julia> setformat(decorations=true)
45-
6
45+
Display parameters:
46+
- format: standard
47+
- decorations: true
48+
- significant figures: 6
4649
4750
julia> X
4851
[3, 4]_com

docs/src/rounding.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ The true value that is actually stored in the variable can be conveniently deter
1313

1414
```jldoctest
1515
julia> big(0.1)
16-
1.000000000000000055511151231257827021181583404541015625000000000000000000000000e-01
16+
0.1000000000000000055511151231257827021181583404541015625
1717
```
1818

1919
So, in fact, the Julia float `0.1` refers to a real number that is slightly greater than 0.1. By default, such calculations are done in round-to-nearest mode (`RoundNearest`); i.e., the nearest representable floating-point number to 0.1 is used.
@@ -22,7 +22,7 @@ So, in fact, the Julia float `0.1` refers to a real number that is slightly grea
2222

2323
```jldoctest
2424
julia> big"0.1"
25-
1.000000000000000000000000000000000000000000000000000000000000000000000000000002e-01
25+
0.1000000000000000000000000000000000000000000000000000000000000000000000000000002
2626
```
2727
]
2828

@@ -68,7 +68,7 @@ The result correctly contains the true 0.4.
6868
Let's look at the internal representation of the `Float64` number 0.1:
6969

7070
```jldoctest
71-
julia> bits(0.1)
71+
julia> bitstring(0.1)
7272
"0011111110111001100110011001100110011001100110011001100110011010"
7373
```
7474
The last 53 bits of these 64 bits correspond to the binary expansion of 0.1, which is

docs/src/usage.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ julia> a = @interval(1)
1515
[1, 1]
1616
1717
julia> typeof(ans)
18-
IntervalArithmetic.Interval{Float64}
18+
Interval{Float64}
1919
2020
julia> b = @interval(1, 2)
2121
[1, 2]
@@ -29,7 +29,7 @@ julia> @biginterval(1, 2)
2929
[1, 2]₂₅₆
3030
3131
julia> showfull(ans)
32-
Interval(1.000000000000000000000000000000000000000000000000000000000000000000000000000000, 2.000000000000000000000000000000000000000000000000000000000000000000000000000000)
32+
Interval(1.0, 2.0)
3333
```
3434

3535
The constructor of the `Interval` type may be used directly, but this is generally not recommended, for the following reason:
@@ -134,7 +134,7 @@ julia> @biginterval "0.1"*2
134134
[0.199999, 0.200001]₂₅₆
135135
136136
julia> showfull(ans)
137-
Interval(1.999999999999999999999999999999999999999999999999999999999999999999999999999983e-01, 2.000000000000000000000000000000000000000000000000000000000000000000000000000004e-01)
137+
Interval(0.1999999999999999999999999999999999999999999999999999999999999999999999999999983, 0.2000000000000000000000000000000000000000000000000000000000000000000000000000004)
138138
139139
```
140140

0 commit comments

Comments
 (0)