Use Documenter v0.27 (#253)

* Use Documenter v0.27

* Bugfixes in docs

* fix interpolation of IdOffsetRange

* import IdOffsetRange in axes doctests

Author: jishnub

Project.toml

@@ -10,7 +10,7 @@ Adapt = "2, 3"
 Aqua = "0.5"
 CatIndices = "0.2"
 DistributedArrays = "0.6"
-Documenter = "0.26"
+Documenter = "0.27"
 EllipsisNotation = "1"
 FillArrays = "0.11"
 StaticArrays = "1"

docs/Project.toml

@@ -4,5 +4,5 @@ JSON = "682c06a0-de6a-54ab-a142-c8b1cf79cde6"
 OffsetArrays = "6fe1bfb0-de20-5000-8ca7-80f57d26f881"
 
 [compat]
-Documenter = "0.26"
+Documenter = "0.27"
 JSON = "0.21"

docs/src/internals.md

@@ -53,7 +53,7 @@ This has a similar design to `Base.IdentityUnitRange` that `ax[x] == x` always h
 julia> ax[5]
 5
 julia> ax[1]
-ERROR: BoundsError: attempt to access 2-element Base.OneTo{Int64} at index [-3]
+ERROR: BoundsError: attempt to access 2-element OffsetArrays.IdOffsetRange{Int64, Base.OneTo{Int64}} with indices 5:6 at index [1]
 [...]
 ```
 

docs/src/reference.md

@@ -8,4 +8,6 @@ OffsetArrays.Origin
 OffsetArrays.IdOffsetRange
 OffsetArrays.no_offset_view
 OffsetArrays.AxisConversionStyle
+OffsetArrays.center
+OffsetArrays.centered
 ```

src/axes.jl

@@ -9,33 +9,35 @@ i.e., it's the "identity," which is the origin of the "Id" in `IdOffsetRange`.
 # Examples
 
 The most common case is shifting a range that starts at 1 (either `1:n` or `Base.OneTo(n)`):
-```jldoctest; setup=:(import OffsetArrays)
-julia> ro = OffsetArrays.IdOffsetRange(1:3, -2)
-OffsetArrays.IdOffsetRange(values=-1:1, indices=-1:1)
+```jldoctest ior
+julia> using OffsetArrays: IdOffsetRange
+
+julia> ro = IdOffsetRange(1:3, -2)
+IdOffsetRange(values=-1:1, indices=-1:1)
 
 julia> axes(ro, 1)
-OffsetArrays.IdOffsetRange(values=-1:1, indices=-1:1)
+IdOffsetRange(values=-1:1, indices=-1:1)
 
 julia> ro[-1]
 -1
 
 julia> ro[3]
-ERROR: BoundsError: attempt to access 3-element OffsetArrays.$(IdOffsetRange{Int,UnitRange{Int}}) with indices -1:1 at index [3]
+ERROR: BoundsError: attempt to access 3-element $(IdOffsetRange{Int,UnitRange{Int}}) with indices -1:1 at index [3]
 ```
 
 If the range doesn't start at 1, the values may be different from the indices:
-```jldoctest; setup=:(import OffsetArrays)
-julia> ro = OffsetArrays.IdOffsetRange(11:13, -2)
-OffsetArrays.IdOffsetRange(values=9:11, indices=-1:1)
+```jldoctest ior
+julia> ro = IdOffsetRange(11:13, -2)
+IdOffsetRange(values=9:11, indices=-1:1)
 
 julia> axes(ro, 1)     # 11:13 is indexed by 1:3, and the offset is also applied to the axes
-OffsetArrays.IdOffsetRange(values=-1:1, indices=-1:1)
+IdOffsetRange(values=-1:1, indices=-1:1)
 
 julia> ro[-1]
 9
 
 julia> ro[3]
-ERROR: BoundsError: attempt to access 3-element OffsetArrays.$(IdOffsetRange{Int,UnitRange{Int}}) with indices -1:1 at index [3]
+ERROR: BoundsError: attempt to access 3-element $(IdOffsetRange{Int,UnitRange{Int}}) with indices -1:1 at index [3]
 ```
 
 # Extended help