From e379667245fbaffffde2fc6327b576054f4a105c Mon Sep 17 00:00:00 2001 From: Jishnu Bhattacharya <jishnub.github@gmail.com> Date: Wed, 6 Dec 2023 00:15:25 +0530 Subject: [PATCH] Use Documenter v1 to build docs --- docs/Project.toml | 2 +- docs/make.jl | 1 + docs/src/index.md | 48 +++++++++++++++++++++++++++++++++++++++++++++ src/generic/Band.jl | 2 +- 4 files changed, 51 insertions(+), 2 deletions(-) diff --git a/docs/Project.toml b/docs/Project.toml index 5cb78069..1af5dbc3 100644 --- a/docs/Project.toml +++ b/docs/Project.toml @@ -4,5 +4,5 @@ Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4" LazyArrays = "5078a376-72f3-5289-bfd5-ec5146d43c02" [compat] -Documenter = "0.27" +Documenter = "1" LazyArrays = "1" diff --git a/docs/make.jl b/docs/make.jl index 171bcdee..a85334cd 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -8,6 +8,7 @@ makedocs(; ], sitename = "BandedMatrices.jl", authors = "Sheehan Olver, Mikael Slevinsky, and contributors.", + warnonly = :missing_docs, ) diff --git a/docs/src/index.md b/docs/src/index.md index 5ba7b5aa..bdff4fa9 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -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)`. diff --git a/src/generic/Band.jl b/src/generic/Band.jl index 1745d73c..81ffddfe 100644 --- a/src/generic/Band.jl +++ b/src/generic/Band.jl @@ -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`.