Skip to content

docs: Update to a new version of documenter and skip develop #382

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.

Sign up for GitHub

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

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

docs: Update to a new version of documenter and skip develop #382

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
adc46f5
docs: Update to a new version of documenter and skip develop
kunzaatko Sep 18, 2025
1560f48
fix(test): Doctests
kunzaatko Sep 18, 2025
337360e
docs: Add missing docstring to documentation
kunzaatko Sep 18, 2025
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
2 changes: 1 addition & 1 deletion .github/workflows/docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ jobs:
${{ runner.os }}-test-
${{ runner.os }}-
- name: Install dependencies
run: julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()'
run: julia --project=docs/ -e 'using Pkg; Pkg.instantiate()'
- name: Build and deploy
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
Expand Down
5 changes: 4 additions & 1 deletion docs/Project.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@ Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
JSON = "682c06a0-de6a-54ab-a142-c8b1cf79cde6"
OffsetArrays = "6fe1bfb0-de20-5000-8ca7-80f57d26f881"

[sources]
OffsetArrays = { path = ".." }

[compat]
Documenter = "0.27"
Documenter = "^1"
JSON = "0.21"
5 changes: 5 additions & 0 deletions docs/src/reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,8 @@ OffsetArrays.AxisConversionStyle
OffsetArrays.center
OffsetArrays.centered
```

# Internals
```@docs
Base.unsafe_wrap(::OffsetArrays.OffsetArrayUnion{T,N}, ::Ptr{T}, ::NTuple{N, OffsetArrays.OffsetAxisKnownLength}) where {T,N}
```
4 changes: 2 additions & 2 deletions src/axes.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ julia> ro[-1]
-1

julia> ro[3]
ERROR: BoundsError: attempt to access 3-element $(IdOffsetRange{Int, UnitRange{Int}}) with indices -1:1 at index [3]
ERROR: BoundsError: attempt to access 3-element $(nameof(IdOffsetRange)){$(nameof(Int)), UnitRange{$(nameof(Int))}} with indices -1:1 at index [3]
```

If the range doesn't start at 1, the values may be different from the indices:
Expand All @@ -37,7 +37,7 @@ julia> ro[-1]
9

julia> ro[3]
ERROR: BoundsError: attempt to access 3-element $(IdOffsetRange{Int, UnitRange{Int}}) with indices -1:1 at index [3]
ERROR: BoundsError: attempt to access 3-element $(nameof(IdOffsetRange)){$(nameof(Int)), UnitRange{$(nameof(Int))}} with indices -1:1 at index [3]
```

# Extended help
Expand Down
Loading