Various docfixes

Author: lkdvos

docs/Project.toml

@@ -1,6 +1,7 @@
 [deps]
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
 DocumenterCitations = "daee34ce-89f3-4625-b898-19384cb65244"
+DocumenterInterLinks = "d12716ef-a0f6-4df4-a9f1-a5a34e75c656"
 KrylovKit = "0b1a1467-8014-51b9-945f-bf0ae24f4b77"
 MPSKit = "bb1c41ca-d63c-52ed-829e-0820dda26502"
 Plots = "91a5bcdd-55d7-5caf-9e0b-520d859cae80"

docs/make.jl

@@ -10,6 +10,7 @@ end
 using MPSKit
 using Documenter
 using DocumenterCitations
+using DocumenterInterLinks
 
 # examples
 example_dir = joinpath(@__DIR__, "src", "examples")
@@ -24,6 +25,10 @@ end
 bibpath = joinpath(@__DIR__, "src", "assets", "mpskit.bib")
 bib = CitationBibliography(bibpath; style=:authoryear)
 
+# interlinks
+links = InterLinks("TensorKit" => "https://jutho.github.io/TensorKit.jl/stable/",
+                   "TensorOperations" => "https://jutho.github.io/TensorOperations.jl/stable/")
+
 # include MPSKit in all doctests
 DocMeta.setdocmeta!(MPSKit, :DocTestSetup, :(using MPSKit, TensorKit); recursive=true)
 
@@ -32,7 +37,6 @@ mathengine = MathJax3(Dict(:loader => Dict("load" => ["[tex]/physics"]),
                                         "tags" => "ams",
                                         "packages" => ["base", "ams", "autoload", "physics"])))
 makedocs(;
-         modules=[MPSKit],
          sitename="MPSKit.jl",
          format=Documenter.HTML(;
                                 prettyurls=get(ENV, "CI", nothing) == "true",
@@ -49,7 +53,7 @@ makedocs(;
                 "Examples" => "examples/index.md",
                 "Library" => "lib/lib.md",
                 "References" => "references.md"],
-         warnonly=true,
-         plugins=[bib])
+         checkdocs=:exports,
+         plugins=[bib, links])
 
 deploydocs(; repo="github.com/QuantumKitHub/MPSKit.jl.git", push_preview=true)

docs/src/man/intro.md

@@ -1,8 +1,8 @@
 # Prerequisites
 
 The following sections describe the prerequisites for using MPSKit. If you are already
-familiar with the concepts of MPSKit and TensorKit, you can skip to the [Overview](@ref)
-section.
+familiar with the concepts of MPSKit and TensorKit, you can skip to the [Conventions](@ref)
+sections.
 
 ## TensorKit
 

docs/src/man/operators.md

@@ -2,7 +2,7 @@
 
 In analogy to how we can define matrix product states as a contraction of local tensors, a
 similar construction exist for operators. To that end, a Matrix Product Operator (MPO) is
-nothing more than a collection of local [`MPOTensor`](@ref) objects, contracted along a
+nothing more than a collection of local [`MPOTensor`](@ref MPSKit.MPOTensor) objects, contracted along a
 line. Again, we can distinguish between finite and infinite operators, with the latter being
 represented by a periodic array of MPO tensors.
 
@@ -13,7 +13,7 @@ These objects can be created either directly from a vector of `MPOTensor`s, or s
 a dense operator (a subtype of `AbstractTensorMap{S,N,N}`), which is then decomposed into a
 product of local tensors.
 
-![](mpo.svg)
+![](../assets/mpo.svg)
 
 ```@setup operators
 using TensorKit, MPSKit

src/algorithms/groundstate/idmrg.jl

@@ -88,7 +88,7 @@ $(TYPEDFIELDS)
 - `eigalg::A`: eigensolver algorithm
 - `maxiter::Int`: maximum number of outer iterations
 - `verbosity::Int`: display progress information
-- `trscheme::TruncationScheme`: truncation algorithm for [tsvd][TensorKit.tsvd](@ref)
+- `trscheme::TruncationScheme`: truncation algorithm for [`tsvd`][TensorKit.tsvd](@extref)
 """
 struct IDMRG2{A} <: Algorithm
     "tolerance for convergence criterium"

src/operators/mpohamiltonian.jl

@@ -3,7 +3,7 @@
     MPOHamiltonian(lattice::AbstractArray{<:VectorSpace})
     MPOHamiltonian(x::AbstractArray{<:Any,3})
 
-MPO representation of a hamiltonian. This is a specific form of a [`SparseMPO`](@ref), where
+MPO representation of a hamiltonian. This is a specific form of an [`AbstractMPO`](@ref), where
 all the sites are represented by an upper triangular block matrix of the following form:
 
 ```math

src/operators/multilinempo.jl

@@ -1,15 +1,15 @@
 # MultilineMPO
 # ------------
 """
-    const MultilineMPO = Multiline{<:Union{SparseMPO,DenseMPO}}
+    const MultilineMPO = Multiline{<:AbstractMPO}
 
 Type that represents multiple lines of `MPO` objects.
 
 # Constructors
     MultilineMPO(mpos::AbstractVector{<:Union{SparseMPO,DenseMPO}})
     MultilineMPO(Os::AbstractMatrix{<:MPOTensor})
 
-See also: [`Multiline`](@ref), [`SparseMPO`](@ref), [`DenseMPO`](@ref)
+See also: [`Multiline`](@ref), [`AbstractMPO`](@ref)
 """
 const MultilineMPO = Multiline{<:AbstractMPO}
 

src/states/abstractmps.jl

@@ -2,6 +2,11 @@
 Tensor types
 ===========================================================================================#
 
+"""
+    MPOTensor{S}
+
+Tensor type for representing local MPO tensors, with the index convention `W ⊗ S ← N ⊗ E`.
+"""
 const MPOTensor{S} = AbstractTensorMap{T,S,2,2} where {T}
 const MPSBondTensor{S} = AbstractTensorMap{T,S,1,1} where {T}
 const GenericMPSTensor{S,N} = AbstractTensorMap{T,S,N,1} where {T} # some functions are also defined for "general mps tensors" (used in peps code)

src/utility/periodicarray.jl

@@ -38,8 +38,21 @@ function PeriodicArray{T,N}(initializer, args...) where {T,N}
     return PeriodicArray(Array{T,N}(initializer, args...))
 end
 
+"""
+    PeriodicVector{T}
+
+One-dimensional dense array with elements of type `T` and periodic boundary conditions.
+Alias for [`PeriodicArray{T,1}`](@ref).
+"""
 const PeriodicVector{T} = PeriodicArray{T,1}
 PeriodicVector(data::AbstractVector{T}) where {T} = PeriodicVector{T}(data)
+
+"""
+    PeriodicMatrix{T}
+
+Two-dimensional dense array with elements of type `T` and periodic boundary conditions.
+Alias for [`PeriodicArray{T,2}`](@ref).
+"""
 const PeriodicMatrix{T} = PeriodicArray{T,2}
 PeriodicMatrix(data::AbstractMatrix{T}) where {T} = PeriodicMatrix{T}(data)
 

src/utility/utility.jl

@@ -151,7 +151,7 @@ end
 """
     tensorexpr(name::Symbol, ind_out, [ind_in])
 
-Generates expressions for use within [`@tensor`](@ref TensorOperations.@tensor) environments
+Generates expressions for use within [`@tensor`](@extref TensorOperations.@tensor) environments
 of the form `name[ind_out...; ind_in]`.
 """
 tensorexpr(name::Symbol, inds) = Expr(:ref, name, inds...)