From d5d29da80fa335b623ecb03d9fd3e0284e6aba15 Mon Sep 17 00:00:00 2001 From: Nick Robinson Date: Mon, 15 Feb 2021 23:11:08 +0000 Subject: [PATCH] Update docs --- README.md | 2 +- docs/Manifest.toml | 63 +++++++++++++++++++++++++++++++++----------- docs/Project.toml | 2 +- docs/make.jl | 10 ++++--- docs/src/index.md | 5 ++-- src/blockdiagonal.jl | 4 +-- 6 files changed, 60 insertions(+), 26 deletions(-) diff --git a/README.md b/README.md index f66d43c..3a0e946 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ [![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://invenia.github.io/BlockDiagonals.jl/stable) [![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://invenia.github.io/BlockDiagonals.jl/dev) -[![CI](https://github.com/invenia/BlockDiagonals.jl/workflows/CI/badge.svg)](https://github.com/Invenia/BlockDiagonals.jl/actions?query=workflow%3ACI) +[![CI](https://github.com/invenia/BlockDiagonals.jl/workflows/CI/badge.svg)](https://github.com/Invenia/BlockDiagonals.jl/actions?query=workflow:CI) [![Codecov](https://codecov.io/gh/invenia/BlockDiagonals.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/invenia/BlockDiagonals.jl) [![code style blue](https://img.shields.io/badge/code%20style-blue-4495d1.svg)](https://github.com/invenia/BlueStyle) diff --git a/docs/Manifest.toml b/docs/Manifest.toml index 4a20187..0a85124 100644 --- a/docs/Manifest.toml +++ b/docs/Manifest.toml @@ -4,36 +4,58 @@ uuid = "2a0f44e3-6c83-55bd-87e4-b1978d98bd5f" [[BlockDiagonals]] -deps = ["FillArrays", "LinearAlgebra"] +deps = ["ChainRulesCore", "FillArrays", "LinearAlgebra"] path = ".." uuid = "0a1fb500-61f7-11e9-3c65-f5ef3456f9f0" -version = "0.1.0" +version = "0.2.0" + +[[ChainRulesCore]] +deps = ["Compat", "LinearAlgebra", "SparseArrays"] +git-tree-sha1 = "de4f08843c332d355852721adb1592bce7924da3" +uuid = "d360d2e6-b24c-11e9-a2a3-2a2ae2dbcce4" +version = "0.9.29" + +[[Compat]] +deps = ["Base64", "Dates", "DelimitedFiles", "Distributed", "InteractiveUtils", "LibGit2", "Libdl", "LinearAlgebra", "Markdown", "Mmap", "Pkg", "Printf", "REPL", "Random", "SHA", "Serialization", "SharedArrays", "Sockets", "SparseArrays", "Statistics", "Test", "UUIDs", "Unicode"] +git-tree-sha1 = "919c7f3151e79ff196add81d7f4e45d91bbf420b" +uuid = "34da2185-b29b-5c13-b0c7-acf172513d20" +version = "3.25.0" [[Dates]] deps = ["Printf"] uuid = "ade2ca70-3891-5945-98fb-dc099432e06a" +[[DelimitedFiles]] +deps = ["Mmap"] +uuid = "8bb1440f-4735-579b-a4ab-409b98df4dab" + [[Distributed]] deps = ["Random", "Serialization", "Sockets"] uuid = "8ba89e20-285c-5b6f-9357-94700520ee1b" [[DocStringExtensions]] deps = ["LibGit2", "Markdown", "Pkg", "Test"] -git-tree-sha1 = "0513f1a8991e9d83255e0140aace0d0fc4486600" +git-tree-sha1 = "50ddf44c53698f5e784bbebb3f4b21c5807401b1" uuid = "ffbed154-4ef7-542d-bbb7-c09d3a79fcae" -version = "0.8.0" +version = "0.8.3" [[Documenter]] -deps = ["Base64", "DocStringExtensions", "InteractiveUtils", "JSON", "LibGit2", "Logging", "Markdown", "REPL", "Test", "Unicode"] -git-tree-sha1 = "4a84478277020abfff208cde31ba1aa68a5bc572" +deps = ["Base64", "Dates", "DocStringExtensions", "IOCapture", "InteractiveUtils", "JSON", "LibGit2", "Logging", "Markdown", "REPL", "Test", "Unicode"] +git-tree-sha1 = "21fb992ef1b28ff8f315354d3808ebf4a8fa6e45" uuid = "e30172f5-a6a5-5a46-863b-614d45cd2de4" -version = "0.23.0" +version = "0.26.2" [[FillArrays]] -deps = ["LinearAlgebra", "Random", "SparseArrays", "Test"] -git-tree-sha1 = "9ab8f76758cbabba8d7f103c51dce7f73fcf8e92" +deps = ["LinearAlgebra", "Random", "SparseArrays"] +git-tree-sha1 = "ff537e5a3cba92fb48f30fec46723510450f2c0e" uuid = "1a297f60-69ca-5386-bcde-b61e274b549b" -version = "0.6.3" +version = "0.10.2" + +[[IOCapture]] +deps = ["Logging"] +git-tree-sha1 = "377252859f740c217b936cebcd918a44f9b53b59" +uuid = "b5f81e59-6552-4d32-b1f0-c071b021bf89" +version = "0.1.1" [[InteractiveUtils]] deps = ["Markdown"] @@ -41,11 +63,12 @@ uuid = "b77e0a4c-d291-57a0-90e8-8db25a27a240" [[JSON]] deps = ["Dates", "Mmap", "Parsers", "Unicode"] -git-tree-sha1 = "b34d7cef7b337321e97d22242c3c2b91f476748e" +git-tree-sha1 = "81690084b6198a2e1da36fcfda16eeca9f9f24e4" uuid = "682c06a0-de6a-54ab-a142-c8b1cf79cde6" -version = "0.21.0" +version = "0.21.1" [[LibGit2]] +deps = ["Printf"] uuid = "76f85450-5226-5b5a-8eaa-529ad045b433" [[Libdl]] @@ -66,13 +89,13 @@ uuid = "d6f4376e-aef5-505a-96c1-9c027394607a" uuid = "a63ad114-7e13-5084-954f-fe012c677804" [[Parsers]] -deps = ["Dates", "Test"] -git-tree-sha1 = "db2b35dedab3c0e46dc15996d170af07a5ab91c9" +deps = ["Dates"] +git-tree-sha1 = "50c9a9ed8c714945e01cd53a21007ed3865ed714" uuid = "69de0a69-1ddd-5017-9359-2bf0b02dc9f0" -version = "0.3.6" +version = "1.0.15" [[Pkg]] -deps = ["Dates", "LibGit2", "Markdown", "Printf", "REPL", "Random", "SHA", "UUIDs"] +deps = ["Dates", "LibGit2", "Libdl", "Logging", "Markdown", "Printf", "REPL", "Random", "SHA", "UUIDs"] uuid = "44cfe95a-1eb2-52ea-b672-e2afdf69b78f" [[Printf]] @@ -93,6 +116,10 @@ uuid = "ea8e919c-243c-51af-8825-aaa63cd721ce" [[Serialization]] uuid = "9e88b42a-f829-5b0c-bbe9-9e923198166b" +[[SharedArrays]] +deps = ["Distributed", "Mmap", "Random", "Serialization"] +uuid = "1a1011a3-84de-559e-8e89-a11a2f7dc383" + [[Sockets]] uuid = "6462fe0b-24de-5631-8697-dd941f90decc" @@ -100,6 +127,10 @@ uuid = "6462fe0b-24de-5631-8697-dd941f90decc" deps = ["LinearAlgebra", "Random"] uuid = "2f01184e-e22b-5df5-ae63-d93ebab69eaf" +[[Statistics]] +deps = ["LinearAlgebra", "SparseArrays"] +uuid = "10745b16-79ce-11e8-11f9-7d13ad32a3b2" + [[Test]] deps = ["Distributed", "InteractiveUtils", "Logging", "Random"] uuid = "8dfed614-e22c-5e08-85e1-65c5234f0b40" diff --git a/docs/Project.toml b/docs/Project.toml index 31cea1d..5629748 100644 --- a/docs/Project.toml +++ b/docs/Project.toml @@ -3,4 +3,4 @@ BlockDiagonals = "0a1fb500-61f7-11e9-3c65-f5ef3456f9f0" Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4" [compat] -Documenter = "~0.23" +Documenter = "0.26" diff --git a/docs/make.jl b/docs/make.jl index 870e79a..6844029 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -1,16 +1,20 @@ -using Documenter, BlockDiagonals +using BlockDiagonals +using Documenter makedocs(; modules=[BlockDiagonals], - format=Documenter.HTML(prettyurls = get(ENV, "CI", nothing) == "true"), + format=Documenter.HTML(prettyurls=false), pages=[ "Home" => "index.md", ], - repo="https://github.com/invenia/BlockDiagonals.jl/blob/{commit}{path}#L{line}", + repo="https://github.com/invenia/BlockDiagonals.jl/blob/{commit}{path}#{line}", sitename="BlockDiagonals.jl", authors="Invenia Technical Computing", + strict=true, + checkdocs=:exports, ) deploydocs(; repo="github.com/invenia/BlockDiagonals.jl", + push_preview=true, ) diff --git a/docs/src/index.md b/docs/src/index.md index 6fffd1a..aa1fcfa 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -1,11 +1,10 @@ # BlockDiagonals.jl -[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://invenia.github.io/BlockDiagonals.jl/stable) [![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://invenia.github.io/BlockDiagonals.jl/dev) -![CI](https://github.com/invenia/BlockDiagonals.jl/workflows/CI/badge.svg) +[![CI](https://github.com/invenia/BlockDiagonals.jl/workflows/CI/badge.svg)](https://github.com/Invenia/BlockDiagonals.jl/actions?query=workflow:CI) [![Codecov](https://codecov.io/gh/invenia/BlockDiagonals.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/invenia/BlockDiagonals.jl) -Functionality for working efficiently with [block diagonal matrices](https://en.wikipedia.org/wiki/Block_matrix#Block_diagonal_matrices). +[BlockDiagonals.jl](https://github.com/invenia/BlockDiagonals.jl) provides functionality for working efficiently with [block diagonal matrices](https://en.wikipedia.org/wiki/Block_matrix#Block_diagonal_matrices). ```@autodocs Modules = [BlockDiagonals] diff --git a/src/blockdiagonal.jl b/src/blockdiagonal.jl index f974700..9842dfb 100644 --- a/src/blockdiagonal.jl +++ b/src/blockdiagonal.jl @@ -25,7 +25,7 @@ BlockDiagonal(B::BlockDiagonal) = B is_square(A::AbstractMatrix) = size(A, 1) == size(A, 2) """ - blocks(B::BlockDiagonal{T, V}) -> Vector{V} + blocks(B::BlockDiagonal{T, V}) -> V Return the on-diagonal blocks of B. """ @@ -33,7 +33,7 @@ blocks(B::BlockDiagonal) = B.blocks # BlockArrays-like functions """ - blocksizes(B::BlockDiagonal) -> Vector{Tuple} + blocksizes(B::BlockDiagonal{T, V}) -> V Return the size of each on-diagonal block in order.