Skip to content

Commit

Permalink
Use Documenter v1 to build docs (#412)
Browse files Browse the repository at this point in the history
  • Loading branch information
jishnub authored Dec 6, 2023
1 parent 00ad0aa commit ce4519d
Show file tree
Hide file tree
Showing 4 changed files with 51 additions and 2 deletions.
2 changes: 1 addition & 1 deletion docs/Project.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,5 @@ Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
LazyArrays = "5078a376-72f3-5289-bfd5-ec5146d43c02"

[compat]
Documenter = "0.27"
Documenter = "1"
LazyArrays = "1"
1 change: 1 addition & 0 deletions docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ makedocs(;
],
sitename = "BandedMatrices.jl",
authors = "Sheehan Olver, Mikael Slevinsky, and contributors.",
warnonly = :missing_docs,
)


Expand Down
48 changes: 48 additions & 0 deletions docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,54 @@ BandRange
BandedMatrices.isbanded
```

```@docs
BandedMatrices.BandSlice
```

```@docs
BandedMatrices.colstart
```

```@docs
BandedMatrices.colstop
```

```@docs
BandedMatrices.colrange
```

```@docs
BandedMatrices.collength
```

```@docs
BandedMatrices.rowstart
```

```@docs
BandedMatrices.rowstop
```

```@docs
BandedMatrices.rowrange
```

```@docs
BandedMatrices.rowlength
```

```@docs
BandedMatrices.bandeddata
```

```@docs
BandedMatrices.BandedMatrixBand
```

```@docs
BandedMatrices.dataview
```

To loop over the nonzero elements of a BandedMatrix, you can use `colrange(A, c)` and `rowrange(A, r)`.


Expand Down
2 changes: 1 addition & 1 deletion src/generic/Band.jl
Original file line number Diff line number Diff line change
Expand Up @@ -188,7 +188,7 @@ checkbandmatch(A::AbstractMatrix, V::AbstractMatrix, ::Colon, ::Colon) =
Represent a `StepRange` of indices corresponding to a band.
Upon calling `to_indices()`, `Band`s are converted to `BandSlice` objects to represent
Upon calling `to_indices`, `Band`s are converted to `BandSlice` objects to represent
the indices over which the `Band` spans.
This mimics the relationship between `Colon` and `Base.Slice`.
Expand Down

0 comments on commit ce4519d

Please sign in to comment.