Skip to content

Scope the ecosystem docs to the released package set #56

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mtfishman merged 1 commit into from
Jun 22, 2026
Merged

Scope the ecosystem docs to the released package set #56

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Project.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name = "ITensorDocsNext"
uuid = "701fd796-f527-45da-9a53-2681c1a90c45"
version = "0.1.16"
version = "0.1.17"
authors = ["ITensor developers <support@itensor.org> and contributors"]

[workspace]
Expand Down
25 changes: 6 additions & 19 deletions docs/make.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,9 @@ Documenter.makedocs(;
modules = [ITensorDocsNext],
warnonly = true,
format = Documenter.HTML(; assets = ["assets/favicon.ico", "assets/extras.css"]),
pages = ["index.md", "ecosystem_overview.md", "upgrade_guide.md"]
# `upgrade_guide.md` is kept in source but left out of the nav until it gets a
# rewrite to match the current next-generation API.
pages = ["index.md", "ecosystem_overview.md"]
)

@info "Building aggregate ITensorDocsNext site"
Expand All @@ -50,36 +52,21 @@ docs = [
"Tensor Network Libraries", itensor_multidocref.(["ITensorNetworksNext"])
),
MultiDocumenter.DropdownNav(
"Array Libraries",
"Tensor Libraries",
itensor_multidocref.(
[
"ITensorBase",
"NamedDimsArrays",
"TensorAlgebra",
"BlockSparseArrays",
"GradedArrays",
"SparseArraysBase",
"DiagonalArrays",
"KroneckerArrays",
]
)
),
MultiDocumenter.DropdownNav(
"Symmetric Tensors", itensor_multidocref.(["FusionTensors", "GradedArrays"])
),
MultiDocumenter.DropdownNav(
"Graph Libraries", itensor_multidocref.(["NamedGraphs", "DataGraphs"])
),
MultiDocumenter.DropdownNav(
"Developer Tools",
itensor_multidocref.(
[
"FunctionImplementations",
"TypeParameterAccessors",
"MapBroadcast",
"BackendSelection",
"ITensorPkgSkeleton",
]
)
"Developer Tools", itensor_multidocref.(["ITensorPkgSkeleton"])
),
]

Expand Down
14 changes: 3 additions & 11 deletions docs/src/ecosystem_overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,7 @@ graph TD
ITensorNetworksNext(ITensorNetworksNext.jl) --> ITensorBase(ITensorBase.jl)
ITensorNetworksNext --> DataGraphs(DataGraphs.jl)
DataGraphs --> NamedGraphs(NamedGraphs.jl)
ITensorBase --> NamedDimsArrays(NamedDimsArrays.jl)
NamedDimsArrays --> SparseArraysBase(SparseArraysBase.jl)
NamedDimsArrays --> DiagonalArrays(DiagonalArrays.jl)
NamedDimsArrays --> BlockSparseArrays(BlockSparseArrays.jl)
NamedDimsArrays --> GradedArrays(GradedArrays.jl)
NamedDimsArrays --> FusionTensors(FusionTensors.jl)
FusionTensors --> GradedArrays
GradedArrays --> BlockSparseArrays
BlockSparseArrays --> SparseArraysBase
BlockSparseArrays --> DiagonalArrays
DiagonalArrays --> SparseArraysBase
ITensorBase --> TensorAlgebra(TensorAlgebra.jl)
GradedArrays(GradedArrays.jl) --> TensorAlgebra
GradedArrays --> SparseArraysBase(SparseArraysBase.jl)
```