.github/workflows/CI.yml

@@ -13,22 +13,22 @@ jobs:
       fail-fast: false
       matrix:
         version:
-          - '1.6'
+          - 'lts'
           - '1'
-#          - 'nightly'
+          - 'nightly'
         os:
           - ubuntu-latest
           - macOS-latest
           - windows-latest
         arch:
           - x64
     steps:
-      - uses: actions/checkout@v3
-      - uses: julia-actions/setup-julia@v1
+      - uses: actions/checkout@v4
+      - uses: julia-actions/setup-julia@v2
         with:
           version: ${{ matrix.version }}
           arch: ${{ matrix.arch }}
-      - uses: actions/cache@v3
+      - uses: actions/cache@v4
         env:
           cache-name: cache-artifacts
         with:
@@ -41,6 +41,6 @@ jobs:
       - uses: julia-actions/julia-buildpkg@v1
       - uses: julia-actions/julia-runtest@v1
       - uses: julia-actions/julia-processcoverage@v1
-      - uses: codecov/codecov-action@v3
+      - uses: codecov/codecov-action@v5
         with:
-          file: lcov.info
+          files: lcov.info

.github/workflows/Invalidations.yml

@@ -16,15 +16,15 @@ jobs:
     if: github.base_ref == github.event.repository.default_branch
     runs-on: ubuntu-latest
     steps:
-    - uses: julia-actions/setup-julia@v1
+    - uses: julia-actions/setup-julia@v2
       with:
         version: '1'
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - uses: julia-actions/julia-buildpkg@v1
     - uses: julia-actions/julia-invalidations@v1
       id: invs_pr
 
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
       with:
         ref: ${{ github.event.repository.default_branch }}
     - uses: julia-actions/julia-buildpkg@v1

.github/workflows/docs.yml

@@ -0,0 +1,17 @@
+name: Documentation
+on:
+  push:
+    branches: [master]
+    tags: [v*]
+  pull_request:
+jobs:
+  docs:
+    name: Documentation
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: julia-actions/julia-buildpkg@v1
+      - uses: julia-actions/julia-docdeploy@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}

.gitignore

@@ -4,3 +4,4 @@
 .DS_Store
 Manifest.toml
 /docs/build/
+/test/out_plot

Project.toml

@@ -1,27 +1,44 @@
 name = "IntervalSets"
 uuid = "8197267c-284f-5f27-9208-e0e47529a953"
-version = "0.7.7"
+version = "0.7.10"
 
 [deps]
-Dates = "ade2ca70-3891-5945-98fb-dc099432e06a"
 Random = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"
+RecipesBase = "3cdcf5f2-1ef4-517c-9805-6587b60abb01"
 Statistics = "10745b16-79ce-11e8-11f9-7d13ad32a3b2"
 
 [weakdeps]
+Random = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"
+RecipesBase = "3cdcf5f2-1ef4-517c-9805-6587b60abb01"
 Statistics = "10745b16-79ce-11e8-11f9-7d13ad32a3b2"
 
 [extensions]
+IntervalSetsRandomExt = "Random"
+IntervalSetsRecipesBaseExt = "RecipesBase"
 IntervalSetsStatisticsExt = "Statistics"
 
 [compat]
+Aqua = "0.8"
+Dates = "1"
+OffsetArrays = "1"
+Plots = "1"
+Random = "1"
+RecipesBase = "1"
+Statistics = "1"
+Test = "1"
+Unitful = "1"
 julia = "1.6"
 
 [extras]
+Aqua = "4c88cf16-eb10-579e-8560-4a9242c79595"
+Dates = "ade2ca70-3891-5945-98fb-dc099432e06a"
 OffsetArrays = "6fe1bfb0-de20-5000-8ca7-80f57d26f881"
+Plots = "91a5bcdd-55d7-5caf-9e0b-520d859cae80"
 Random = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"
+RecipesBase = "3cdcf5f2-1ef4-517c-9805-6587b60abb01"
 Statistics = "10745b16-79ce-11e8-11f9-7d13ad32a3b2"
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
 Unitful = "1986cc42-f94f-5a68-af5c-568840ba703d"
 
 [targets]
-test = ["Test", "Random", "OffsetArrays", "Statistics", "Unitful"]
+test = ["Aqua", "Dates", "Test", "Plots", "Random", "RecipesBase", "OffsetArrays", "Statistics", "Unitful"]

README.md

@@ -1,98 +1,28 @@
 # IntervalSets.jl
 Interval Sets for Julia
 
+[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://JuliaMath.github.io/IntervalSets.jl/stable)
+[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://JuliaMath.github.io/IntervalSets.jl/dev)
 [![Build Status](https://github.com/JuliaMath/IntervalSets.jl/workflows/CI/badge.svg)](https://github.com/JuliaMath/IntervalSets.jl/actions)
 [![Coverage](https://codecov.io/gh/JuliaMath/IntervalSets.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/JuliaMath/IntervalSets.jl)
+[![Aqua QA](https://raw.githubusercontent.com/JuliaTesting/Aqua.jl/master/badge.svg)](https://github.com/JuliaTesting/Aqua.jl)
 
-This package represents intervals of an ordered set. For an interval
-spanning from `a` to `b`, all values `x` that lie between `a` and `b`
-are defined as being members of the interval.
-
-This package is intended to implement a "minimal" foundation for
-intervals upon which other packages might build. In particular, we
-*encourage* [type-piracy](https://docs.julialang.org/en/v1/manual/style-guide/#Avoid-type-piracy)
-for the reason that only one interval package can
-unambiguously define the `..` and `±` operators (see below).
-
-Currently this package defines one concrete type, `Interval`.
-These define the set spanning from `a` to `b`, meaning the
-interval is defined as the set `{x}` satisfying `a ≤ x ≤ b`. This is
-sometimes written `[a,b]` (mathematics syntax, not Julia syntax) or
-`a..b`.
-
-Optionally, `Interval{L,R}` can represent open and half-open intervals. The type
-parameters `L` and `R` correspond to the left and right endpoint respectively.
-The notation `ClosedInterval` is short for `Interval{:closed,:closed}`, while `OpenInterval` is short for `Interval{:open,:open}`. For example, the interval `Interval{:open,:closed}` corresponds to the set `{x}` satisfying `a < x ≤ b`.
-
-## Usage
-
-You can construct `ClosedInterval`s in a variety of ways:
+## Quick start
 
 ```julia
 julia> using IntervalSets
 
-julia> ClosedInterval{Float64}(1,3)
-1.0..3.0
-
-julia> 0.5..2.5
-0.5..2.5
-
-julia> 1.5±1
-0.5..2.5
-```
-
-Similarly, you can construct `OpenInterval`s and `Interval{:open,:closed}`s, and `Interval{:closed,:open}`:
-```julia
-julia> OpenInterval{Float64}(1,3)
-1.0..3.0 (open)
-
-julia> OpenInterval(0.5..2.5)
-0.5..2.5 (open)
-
-julia> Interval{:open,:closed}(1,3)
-1..3 (open–closed)
-```
-
-The `±` operator may be typed as `\pm<TAB>` (using Julia's LaTeX
-syntax tab-completion).
+julia> i1 = 1.0 .. 3.0
+1.0 .. 3.0
 
-Intervals also support the expected set operations:
+julia> i2 = OpenInterval(0..4)
+0 .. 4 (open)
 
-```julia
-julia> 1.75 ∈ 1.5±1  # \in<TAB>; can also use `in`
+julia> i1 ⊆ i2
 true
 
-julia> 0 ∈ 1.5±1
-false
-
-julia> 1 ∈ OpenInterval(0..1)
-false
-
-julia> intersect(1..5, 3..7)   # can also use `a ∩ b`, where the symbol is \cap<TAB>
-3..5
-
-julia> isempty(intersect(1..5, 10..11))
-true
-
-julia> (0.25..5) ∪ (3..7.4)    # \cup<TAB>; can also use union()
-0.25..7.4
-
-julia> isclosedset(0.5..2.0)
-true
-
-julia> isopenset(OpenInterval(0.5..2.5))
-true
-
-julia> isleftopen(2..3)
+julia> i2 ⊆ i1
 false
 ```
 
-When computing the union, the result must also be an interval:
-```julia
-julia> (0.25..5) ∪ (6..7.4)
------- ArgumentError ------------------- Stacktrace (most recent call last)
-
- [1] — union(::IntervalSets.ClosedInterval{Float64}, ::IntervalSets.ClosedInterval{Float64}) at closed.jl:34
-
-ArgumentError: Cannot construct union of disjoint sets.
-```
+Please refer to the [documentation](https://JuliaMath.github.io/IntervalSets.jl/stable) for comprehensive guides and examples.

docs/Project.toml

@@ -0,0 +1,7 @@
+[deps]
+Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
+IntervalSets = "8197267c-284f-5f27-9208-e0e47529a953"
+Plots = "91a5bcdd-55d7-5caf-9e0b-520d859cae80"
+
+[compat]
+Documenter = "1"

docs/make.jl

@@ -0,0 +1,28 @@
+using IntervalSets
+using Documenter
+
+# We need to set `ENV["GKSwstype"]` to suppress the warning on GitHub Actions.
+# https://github.com/JuliaPlots/Plots.jl/issues/1076#issuecomment-327509819
+ENV["GKSwstype"] = "100"
+
+DocMeta.setdocmeta!(IntervalSets, :DocTestSetup, :(using IntervalSets); recursive=true)
+
+makedocs(;
+    modules=[IntervalSets],
+    repo="https://github.com/JuliaMath/IntervalSets.jl/blob/{commit}{path}#{line}",
+    sitename="IntervalSets.jl",
+    format=Documenter.HTML(;
+        prettyurls=get(ENV, "CI", "false") == "true",
+        canonical="https://JuliaMath.github.io/IntervalSets.jl",
+        assets = ["assets/custom.css", "assets/favicon.ico"],
+        repolink="https://github.com/JuliaMath/IntervalSets.jl",
+    ),
+    pages=[
+        "Home" => "index.md",
+        "APIs" => "api.md",
+    ],
+)
+
+deploydocs(;
+    repo="github.com/JuliaMath/IntervalSets.jl", devbranch="master",
+)

docs/src/api.md

@@ -0,0 +1,6 @@
+# API
+
+```@autodocs
+Modules = [IntervalSets]
+Order   = [:type, :function, :macro]
+```