Fix and test docstrings, and use Documenter v1 for docs (#324)

* Fix and test docstrings, and use Docuemnter v1 for docs

* Change 7. to 7.0 in Fill docstring

* Ignore manual files

Author: jishnub

Project.toml

@@ -22,6 +22,7 @@ FillArraysStatisticsExt = "Statistics"
 [compat]
 Aqua = "0.8"
 Base64 = "1.6"
+Documenter = "1"
 Infinities = "0.1"
 LinearAlgebra = "1.6"
 PDMats = "0.11.17"
@@ -36,6 +37,7 @@ julia = "1.6"
 [extras]
 Aqua = "4c88cf16-eb10-579e-8560-4a9242c79595"
 Base64 = "2a0f44e3-6c83-55bd-87e4-b1978d98bd5f"
+Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
 Infinities = "e1ba4f0e-776d-440f-acd9-e1d2e9742647"
 PDMats = "90014a1f-27ba-587c-ab20-58faa44d9150"
 ReverseDiff = "37e2e3b7-166d-5795-8a7a-e32c996b4267"
@@ -45,4 +47,4 @@ Statistics = "10745b16-79ce-11e8-11f9-7d13ad32a3b2"
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
 
 [targets]
-test = ["Aqua", "Test", "Base64", "Infinities", "PDMats", "ReverseDiff", "SparseArrays", "StaticArrays", "Statistics"]
+test = ["Aqua", "Test", "Base64", "Infinities", "PDMats", "ReverseDiff", "SparseArrays", "StaticArrays", "Statistics", "Documenter"]

docs/Project.toml

@@ -6,5 +6,7 @@ SparseArrays = "2f01184e-e22b-5df5-ae63-d93ebab69eaf"
 StaticArrays = "90137ffa-7385-5640-81b9-e52037218182"
 
 [compat]
-Documenter = "0.27"
+Documenter = "1"
+Random = "1"
+SparseArrays = "1"
 StaticArrays = "1"

docs/src/index.md

@@ -69,7 +69,7 @@ The elements of a `Fill` array don't need to be restricted to numbers, and these
 
 ```jldoctest
 julia> f = Fill("hello", 2,5)
-2×5 Fill{String}, with entries equal to hello
+2×5 Fill{String}, with entries equal to "hello"
 
 julia> Array(f)
 2×5 Matrix{String}:

src/FillArrays.jl

@@ -94,14 +94,10 @@ Typically created by `Fill` or `Zeros` or `Ones`
 
 ```jldoctest
 julia> Fill(7, (2,3))
-2×3 Fill{Int64,2,Tuple{Base.OneTo{Int64},Base.OneTo{Int64}}}:
- 7  7  7
- 7  7  7
-
-julia> Fill{Float64, 1, Tuple{UnitRange{Int64}}}(7., (1:2,))
-2-element Fill{Float64,1,Tuple{UnitRange{Int64}}} with indices 1:2:
- 7.0
- 7.0
+2×3 Fill{Int64}, with entries equal to 7
+
+julia> Fill{Float64, 1, Tuple{UnitRange{Int64}}}(7.0, (1:2,))
+2-element Fill{Float64, 1, Tuple{UnitRange{Int64}}} with indices 1:2, with entries equal to 7.0
 ```
 """
 struct Fill{T, N, Axes} <: AbstractFill{T, N, Axes}
@@ -716,12 +712,9 @@ function Base.show(io::IO, ::MIME"text/plain", x::Union{Eye, AbstractFill})
         return show(io, x)
     end
     summary(io, x)
-    if x isa Union{AbstractZeros, AbstractOnes, Eye}
-        # then no need to print entries
-    elseif length(x) > 1
-        print(io, ", with entries equal to ", getindex_value(x))
-    else
-        print(io, ", with entry equal to ", getindex_value(x))
+    if !(x isa Union{AbstractZeros, AbstractOnes, Eye})
+        print(io, ", with ", length(x) > 1 ? "entries" : "entry", " equal to ")
+        show(io, getindex_value(x))
     end
 end
 

src/trues.jl

@@ -7,17 +7,24 @@ Typically created using `Trues(dims)` or `Trues(dims...)`
 
 # Example
 ```jldoctest
-julia> Trues(1,3)
-1×3 Ones{Bool,2,Tuple{Base.OneTo{Int64},Base.OneTo{Int64}}} = true
+julia> T = Trues(1,3)
+1×3 Ones{Bool}
 
-julia> Trues((2,3))
-2×3 Ones{Bool,2,Tuple{Base.OneTo{Int64},Base.OneTo{Int64}}} = true
+julia> Array(T)
+1×3 Matrix{Bool}:
+ 1  1  1
 ```
 """
 const Trues = Ones{Bool, N, Axes} where {N, Axes}
 
 
-""" `Falses = Zeros{Bool, N, Axes}` (see `Trues`) """
+"""
+    Falses = Zeros{Bool, N, Axes}
+
+Lazy version of `falses` with axes.
+
+See also: [`Trues`](@ref)
+"""
 const Falses = Zeros{Bool, N, Axes} where {N, Axes}
 
 

test/runtests.jl

@@ -1,6 +1,10 @@
 using FillArrays, LinearAlgebra, PDMats, SparseArrays, StaticArrays, ReverseDiff, Random, Base64, Test, Statistics
 import FillArrays: AbstractFill, RectDiagonal, SquareEye
 
+using Documenter
+DocMeta.setdocmeta!(FillArrays, :DocTestSetup, :(using FillArrays))
+doctest(FillArrays; manual = false)
+
 using Aqua
 @testset "Project quality" begin
     Aqua.test_all(FillArrays;