diff --git a/.github/workflows/VersionCheck.yml b/.github/workflows/VersionCheck.yml new file mode 100644 index 0000000..69444f1 --- /dev/null +++ b/.github/workflows/VersionCheck.yml @@ -0,0 +1,11 @@ +name: "Version Check" + +on: + pull_request: + +jobs: + version-check: + name: "Version Check" + uses: "ITensor/ITensorActions/.github/workflows/VersionCheck.yml@main" + with: + localregistry: https://github.com/ITensor/ITensorRegistry.git diff --git a/Project.toml b/Project.toml index af675f7..d20a13e 100644 --- a/Project.toml +++ b/Project.toml @@ -1,7 +1,7 @@ name = "SparseArraysBase" uuid = "0d5efcca-f356-4864-8770-e1ed8d78f208" authors = ["ITensor developers and contributors"] -version = "0.5.3" +version = "0.5.4" [deps] Accessors = "7d9f7c33-5ae7-4f3b-8dc6-eff91059b697" diff --git a/README.md b/README.md index 977d055..956ac7b 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # SparseArraysBase.jl -[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://ITensor.github.io/SparseArraysBase.jl/stable/) -[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://ITensor.github.io/SparseArraysBase.jl/dev/) +[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://itensor.github.io/SparseArraysBase.jl/stable/) +[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://itensor.github.io/SparseArraysBase.jl/dev/) [![Build Status](https://github.com/ITensor/SparseArraysBase.jl/actions/workflows/Tests.yml/badge.svg?branch=main)](https://github.com/ITensor/SparseArraysBase.jl/actions/workflows/Tests.yml?query=branch%3Amain) [![Coverage](https://codecov.io/gh/ITensor/SparseArraysBase.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/ITensor/SparseArraysBase.jl) [![Code Style: Blue](https://img.shields.io/badge/code%20style-blue-4495d1.svg)](https://github.com/invenia/BlueStyle) @@ -9,7 +9,11 @@ ## Support -Flatiron Center for Computational Quantum Physics logo. + + + Flatiron Center for Computational Quantum Physics logo. + + SparseArraysBase.jl is supported by the Flatiron Institute, a division of the Simons Foundation. diff --git a/docs/make.jl b/docs/make.jl index 991d772..eaa08a3 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -12,9 +12,9 @@ makedocs(; authors="ITensor developers and contributors", sitename="SparseArraysBase.jl", format=Documenter.HTML(; - canonical="https://ITensor.github.io/SparseArraysBase.jl", + canonical="https://itensor.github.io/SparseArraysBase.jl", edit_link="main", - assets=String[], + assets=["assets/favicon.ico", "assets/extras.css"], ), pages=["Home" => "index.md", "Reference" => "reference.md"], ) diff --git a/docs/make_index.jl b/docs/make_index.jl index 69006ee..2e425e9 100644 --- a/docs/make_index.jl +++ b/docs/make_index.jl @@ -4,7 +4,8 @@ using SparseArraysBase: SparseArraysBase function ccq_logo(content) include_ccq_logo = """ ```@raw html - Flatiron Center for Computational Quantum Physics logo. + Flatiron Center for Computational Quantum Physics logo. + Flatiron Center for Computational Quantum Physics logo. ``` """ content = replace(content, "{CCQ_LOGO}" => include_ccq_logo) diff --git a/docs/make_readme.jl b/docs/make_readme.jl index 84ac379..a7472b2 100644 --- a/docs/make_readme.jl +++ b/docs/make_readme.jl @@ -3,7 +3,10 @@ using SparseArraysBase: SparseArraysBase function ccq_logo(content) include_ccq_logo = """ - Flatiron Center for Computational Quantum Physics logo. + + + Flatiron Center for Computational Quantum Physics logo. + """ content = replace(content, "{CCQ_LOGO}" => include_ccq_logo) return content @@ -14,5 +17,5 @@ Literate.markdown( joinpath(pkgdir(SparseArraysBase)); flavor=Literate.CommonMarkFlavor(), name="README", - preprocess=ccq_logo, + postprocess=ccq_logo, ) diff --git a/docs/src/assets/CCQ-dark.png b/docs/src/assets/CCQ-dark.png new file mode 100644 index 0000000..fbaef52 Binary files /dev/null and b/docs/src/assets/CCQ-dark.png differ diff --git a/docs/src/assets/CCQ.png b/docs/src/assets/CCQ.png index febbb08..e13f908 100644 Binary files a/docs/src/assets/CCQ.png and b/docs/src/assets/CCQ.png differ diff --git a/docs/src/assets/extras.css b/docs/src/assets/extras.css new file mode 100644 index 0000000..aaab0f8 --- /dev/null +++ b/docs/src/assets/extras.css @@ -0,0 +1,15 @@ +.display-light-only { + display: block; +} + +.display-dark-only { + display: none; +} + +.theme--documenter-dark .display-light-only { + display: none; +} + +.theme--documenter-dark .display-dark-only { + display: block; +} diff --git a/docs/src/assets/favicon.ico b/docs/src/assets/favicon.ico new file mode 100644 index 0000000..0b06780 Binary files /dev/null and b/docs/src/assets/favicon.ico differ diff --git a/docs/src/assets/logo-dark.png b/docs/src/assets/logo-dark.png new file mode 100644 index 0000000..7450635 Binary files /dev/null and b/docs/src/assets/logo-dark.png differ diff --git a/docs/src/assets/logo.png b/docs/src/assets/logo.png new file mode 100644 index 0000000..2682e14 Binary files /dev/null and b/docs/src/assets/logo.png differ diff --git a/examples/README.jl b/examples/README.jl index c64bfdb..4198c08 100644 --- a/examples/README.jl +++ b/examples/README.jl @@ -1,7 +1,7 @@ # # SparseArraysBase.jl # -# [![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://ITensor.github.io/SparseArraysBase.jl/stable/) -# [![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://ITensor.github.io/SparseArraysBase.jl/dev/) +# [![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://itensor.github.io/SparseArraysBase.jl/stable/) +# [![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://itensor.github.io/SparseArraysBase.jl/dev/) # [![Build Status](https://github.com/ITensor/SparseArraysBase.jl/actions/workflows/Tests.yml/badge.svg?branch=main)](https://github.com/ITensor/SparseArraysBase.jl/actions/workflows/Tests.yml?query=branch%3Amain) # [![Coverage](https://codecov.io/gh/ITensor/SparseArraysBase.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/ITensor/SparseArraysBase.jl) # [![Code Style: Blue](https://img.shields.io/badge/code%20style-blue-4495d1.svg)](https://github.com/invenia/BlueStyle)