more fixes for docs

Author: lkdvos

docs/Project.toml

@@ -1,10 +1,9 @@
 [deps]
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
+DocumenterInterLinks = "d12716ef-a0f6-4df4-a9f1-a5a34e75c656"
 Random = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"
 TensorKit = "07d1fe3e-3e46-537d-9eac-e9e13d0d4cec"
-TensorKitSectors = "13a9c161-d5da-41f0-bcbd-e1a08ae0647f"
 
 [compat]
 Documenter = "1"
 Random = "1"
-TensorKitSectors = "0.1"

docs/make.jl

@@ -1,6 +1,14 @@
 using Documenter
 using Random
-using TensorKit, TensorKitSectors
+using TensorKit
+using TensorKit.TensorKitSectors
+using TensorKit.MatrixAlgebraKit
+using DocumenterInterLinks
+
+links = InterLinks(
+    "MatrixAlgebraKit" => "https://quantumkithub.github.io/MatrixAlgebraKit.jl/stable/",
+    "TensorOperations" => "https://quantumkithub.github.io/TensorOperations.jl/stable/",
+)
 
 pages = ["Home" => "index.md",
          "Manual" => ["man/intro.md", "man/tutorial.md", "man/categories.md",
@@ -15,6 +23,7 @@ makedocs(; modules=[TensorKit, TensorKitSectors],
          format=Documenter.HTML(; prettyurls=true, mathengine=MathJax(),
                                 assets=["assets/custom.css"]),
          pages=pages,
-         pagesonly=true)
+         pagesonly=true,
+         plugins= [links,])
 
 deploydocs(; repo="github.com/QuantumKitHub/TensorKit.jl.git", push_preview=true)

docs/src/lib/tensors.md

@@ -219,44 +219,16 @@ and all follow the same strategy. The idea is that the `TensorMap` is interprete
 map  based on the current partition of indices between `domain` and `codomain`, and then the
 entire range of MatrixAlgebraKit functions can be called.
 You can specify an additional permutation of the domain and codomain indices before the
-factorisation is performed by making use of [`permute`](@ref) or [`transpose`](@ref), 
+factorisation is performed by making use of [`permute`](@ref) or [`transpose`](@ref).
 
-```@docs
-left_orth
-right_orth
-left_null
-right_null
-svd_compact
-svd_full
-svd_vals
-eig_full
-eig_vals
-eigh_full
-eigh_vals
-isposdef
-```
+For the full list of factorizations, see [Decompositions](@extref MatrixAlgebraKit).
 
 Additionally, it is possible to obtain truncated versions of some of these factorizations
 through the [`MatrixAlgebraKit.TruncationStrategy`](@ref) objects.
 
-```@docs
-svd_trunc
-eig_trunc
-eigh_trunc
-```
-
-The exact truncation strategy can be controlled through one of the following strategies:
+The exact truncation strategy can be controlled through the strategies defined in [Truncations](@extref MatrixAlgebraKit),
+but for `TensorMap`s there is also the special-purpose scheme:
 
 ```@docs
-notrunc
-trunctol
-truncrank
-truncerr
 truncspace
 ```
-
-It is additionally possible to combine multiple strategies through `&`, e.g.
-
-```julia
-combined_truncation = trunctol(; atol=1e-2) & truncrank(3)
-```

src/TensorKit.jl

@@ -81,6 +81,7 @@ export left_orth, right_orth, left_null, right_null,
        eig_trunc,
        eigh_vals!, eigh_vals, eig_vals!, eig_vals,
        isposdef, isposdef!, ishermitian, isisometry, isunitary, sylvester, rank, cond
+
 # deprecate:
 export eig, eig!, eigh, eigh!, eigen, eigen!, tsvd, tsvd!, leftorth, leftorth!, rightorth,
        rightorth!, leftnull, leftnull!, rightnull, rightnull!

src/tensors/factorizations/truncation.jl

@@ -1,5 +1,8 @@
 # Strategies
 # ----------
+"""
+    notrunc()
+"""
 notrunc() = NoTruncation()
 
 # deprecate
@@ -10,11 +13,22 @@ struct TruncationError{T<:Real} <: TruncationStrategy
     ϵ::T
     p::Real
 end
+
+"""
+    truncerr(epsilon, p)
+"""
 truncerr(epsilon::Real, p::Real=2) = TruncationError(epsilon, p)
 
 struct TruncationSpace{S<:ElementarySpace} <: TruncationStrategy
     space::S
 end
+
+"""
+    truncspace(space::ElementarySpace)
+
+Truncation strategy to keep the first values such that the resulting space is the infimum of
+the total space and the provided space.
+"""
 truncspace(space::ElementarySpace) = TruncationSpace(space)
 
 # Truncation