From c828fb69028a981b61a28a38ac4c766cf6c161c6 Mon Sep 17 00:00:00 2001 From: mtfishman Date: Fri, 21 Mar 2025 11:19:09 -0400 Subject: [PATCH 1/2] Add ecosystem overview diagram --- docs/Project.toml | 2 ++ docs/make.jl | 2 +- docs/src/ecosystem_overview.md | 18 ++++++++++++++++++ 3 files changed, 21 insertions(+), 1 deletion(-) create mode 100644 docs/src/ecosystem_overview.md diff --git a/docs/Project.toml b/docs/Project.toml index cba08976..a97f0d6c 100644 --- a/docs/Project.toml +++ b/docs/Project.toml @@ -1,11 +1,13 @@ [deps] Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4" +DocumenterMermaid = "a078cd44-4d9c-4618-b545-3ab9d77f9177" ITensorDocsNext = "701fd796-f527-45da-9a53-2681c1a90c45" Literate = "98b081ad-f1c9-55d3-8b20-4c87d4299306" MultiDocumenter = "87ed4bf0-c935-4a67-83c3-2a03bee4197c" [compat] Documenter = "1.9.0" +DocumenterMermaid = "0.2.0" ITensorDocsNext = "0.1.0" Literate = "2.20.1" MultiDocumenter = "0.7.1" diff --git a/docs/make.jl b/docs/make.jl index a79af99a..705dac79 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -23,7 +23,7 @@ Documenter.makedocs(; sitename="ITensor ecosystem docs", modules=[ITensorDocsNext], warnonly=true, - pages=["index.md"], + pages=["index.md", "ecosystem_overview.md"], ) @info "Building aggregate ITensorDocsNext site" diff --git a/docs/src/ecosystem_overview.md b/docs/src/ecosystem_overview.md new file mode 100644 index 00000000..74142cf2 --- /dev/null +++ b/docs/src/ecosystem_overview.md @@ -0,0 +1,18 @@ +# ITensor ecosystem overview + +```mermaid +graph TD + ITensors(ITensors.jl) --> ITensorBase(ITensorBase.jl) + ITensorBase --> NamedDimsArrays(NamedDimsArrays.jl) + NamedDimsArrays --> SparseArraysBase(SparseArraysBase.jl) + NamedDimsArrays --> DiagonalArrays(DiagonalArrays.jl) + NamedDimsArrays --> BlockSparseArrays(BlockSparseArrays.jl) + NamedDimsArrays --> FusionTensors(FusionTensors.jl) + BlockSparseArrays --> SparseArraysBase + BlockSparseArrays --> DiagonalArrays + BlockSparseArrays --> GradedUnitRanges(GradedUnitRanges.jl) + DiagonalArrays --> SparseArraysBase + FusionTensors --> BlockSparseArrays + FusionTensors --> GradedUnitRanges + GradedUnitRanges --> SymmetrySectors(SymmetrySectors.jl) +``` From 990ddae87d4df3d986eddb15ec7cc04c1ff01000 Mon Sep 17 00:00:00 2001 From: mtfishman Date: Fri, 21 Mar 2025 11:22:01 -0400 Subject: [PATCH 2/2] Load DocumenterMermaid during docs build --- docs/make.jl | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/make.jl b/docs/make.jl index 705dac79..638ca826 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -7,6 +7,7 @@ # `--temp`, in which case the source repositories are cloned into a temporary # directory (as opposed to `docs/clones`). using Documenter: Documenter +using DocumenterMermaid: DocumenterMermaid using ITensorDocsNext: ITensorDocsNext using MultiDocumenter: MultiDocumenter