Skip to content

Commit ce4519d

Browse files
authored
Use Documenter v1 to build docs (#412)
1 parent 00ad0aa commit ce4519d

File tree

4 files changed

+51
-2
lines changed

4 files changed

+51
-2
lines changed

docs/Project.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,5 @@ Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
44
LazyArrays = "5078a376-72f3-5289-bfd5-ec5146d43c02"
55

66
[compat]
7-
Documenter = "0.27"
7+
Documenter = "1"
88
LazyArrays = "1"

docs/make.jl

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ makedocs(;
88
],
99
sitename = "BandedMatrices.jl",
1010
authors = "Sheehan Olver, Mikael Slevinsky, and contributors.",
11+
warnonly = :missing_docs,
1112
)
1213

1314

docs/src/index.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,54 @@ BandRange
106106
BandedMatrices.isbanded
107107
```
108108

109+
```@docs
110+
BandedMatrices.BandSlice
111+
```
112+
113+
```@docs
114+
BandedMatrices.colstart
115+
```
116+
117+
```@docs
118+
BandedMatrices.colstop
119+
```
120+
121+
```@docs
122+
BandedMatrices.colrange
123+
```
124+
125+
```@docs
126+
BandedMatrices.collength
127+
```
128+
129+
```@docs
130+
BandedMatrices.rowstart
131+
```
132+
133+
```@docs
134+
BandedMatrices.rowstop
135+
```
136+
137+
```@docs
138+
BandedMatrices.rowrange
139+
```
140+
141+
```@docs
142+
BandedMatrices.rowlength
143+
```
144+
145+
```@docs
146+
BandedMatrices.bandeddata
147+
```
148+
149+
```@docs
150+
BandedMatrices.BandedMatrixBand
151+
```
152+
153+
```@docs
154+
BandedMatrices.dataview
155+
```
156+
109157
To loop over the nonzero elements of a BandedMatrix, you can use `colrange(A, c)` and `rowrange(A, r)`.
110158

111159

src/generic/Band.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -188,7 +188,7 @@ checkbandmatch(A::AbstractMatrix, V::AbstractMatrix, ::Colon, ::Colon) =
188188
189189
Represent a `StepRange` of indices corresponding to a band.
190190
191-
Upon calling `to_indices()`, `Band`s are converted to `BandSlice` objects to represent
191+
Upon calling `to_indices`, `Band`s are converted to `BandSlice` objects to represent
192192
the indices over which the `Band` spans.
193193
194194
This mimics the relationship between `Colon` and `Base.Slice`.

0 commit comments

Comments
 (0)