Use Documenter v1 to build docs (#323)

JuliaArrays · Dec 6, 2023 · cb0495f · cb0495f
1 parent 3d8f17e
commit cb0495f
Show file tree

Hide file tree

Showing 5 changed files with 8 additions and 5 deletions.
diff --git a/docs/Project.toml b/docs/Project.toml
@@ -3,4 +3,4 @@ BlockArrays = "8e7c35d0-a365-5155-bbbb-fb81a777f24e"
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
 
 [compat]
-Documenter = "0.27"
+Documenter = "1"
diff --git a/docs/make.jl b/docs/make.jl
@@ -19,7 +19,8 @@ makedocs(
             "lib/public.md",
             "lib/internals.md"
         ]
-    ]
+    ],
+    warnonly = :missing_docs,
 )
 
 # Deploy built documentation from Travis.

diff --git a/docs/src/lib/public.md b/docs/src/lib/public.md
@@ -66,6 +66,8 @@ Base.popfirst!
 
 ```@docs
 PseudoBlockArray
+PseudoBlockVector
+PseudoBlockMatrix
 Base.resize!
 ```
 

diff --git a/src/blockarray.jl b/src/blockarray.jl
@@ -484,7 +484,7 @@ Base.reshape(block_array::BlockArray, dims::Tuple{Vararg{Union{Int,Colon}}}) =
     reshape(PseudoBlockArray(block_array), dims)
 
 """
-resize!(a::BlockVector, N::Block) -> PseudoBlockVector
+    resize!(a::BlockVector, N::Block) -> PseudoBlockVector
 
 Resize `a` to contain the first `N` blocks, returning a new `BlockVector` sharing
 memory with `a`. If `N` is smaller than the current

diff --git a/src/pseudo_blockarray.jl b/src/pseudo_blockarray.jl
@@ -93,7 +93,7 @@ julia> PseudoBlockVector(A, [3,2,1])
  5
  ─
  6
- ```
+```
 """
 const PseudoBlockVector{T} = PseudoBlockArray{T, 1}
 const PseudoBlockVecOrMat{T} = Union{PseudoBlockMatrix{T}, PseudoBlockVector{T}}
@@ -307,7 +307,7 @@ function Base.showarg(io::IO, A::PseudoBlockArray, toplevel::Bool)
     end
 end
 """
-resize!(a::PseudoBlockVector, N::Block) -> PseudoBlockVector
+    resize!(a::PseudoBlockVector, N::Block) -> PseudoBlockVector
 
 Resize `a` to contain the first `N` blocks, returning a new `PseudoBlockVector` sharing
 memory with `a`. If `N` is smaller than the current