Fix docs

Author: mtfishman

docs/Project.toml

@@ -2,6 +2,7 @@
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
 HDF5 = "f67ccb44-e63f-5c2f-98bd-6dc0ccc4ba2f"
 ITensorMPS = "0d1a4710-d33b-49a5-8f18-73bdf49b47e2"
+ITensors = "9136182c-28ba-11e9-034c-db9fb085ebd5"
 LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
 Strided = "5e0ebb24-38b0-5f93-81fe-25c709ecae67"
 

docs/settings.jl

@@ -1,13 +1,17 @@
 using Documenter
 using ITensors
-using ITensorMPS: ITensorMPS
+using ITensorMPS
 
+# Allows using ITensorMPS.jl docstrings in ITensors.jl documentation:
+# https://github.com/JuliaDocs/Documenter.jl/issues/1734
 DocMeta.setdocmeta!(ITensors, :DocTestSetup, :(using ITensors); recursive=true)
 DocMeta.setdocmeta!(ITensorMPS, :DocTestSetup, :(using ITensorMPS); recursive=true)
 
 sitename = "ITensors.jl"
 
 settings = Dict(
+  # Allows using ITensorMPS.jl docstrings in ITensors.jl documentation:
+  # https://github.com/JuliaDocs/Documenter.jl/issues/1734
   :modules => [ITensors, ITensorMPS],
   :pages => [
     "Introduction" => "index.md",

docs/src/DMRG.md

@@ -1,5 +1,5 @@
 # DMRG
 
 ```@docs
-ITensorMPS.dmrg
+dmrg
 ```

docs/src/MPSandMPO.md

@@ -32,125 +32,125 @@ MPO(::Type{<:Number}, ::Vector{<:Index}, ::String)
 ## Copying behavior
 
 ```@docs
-copy(::ITensors.AbstractMPS)
-deepcopy(::ITensors.AbstractMPS)
+copy(::ITensorMPS.AbstractMPS)
+deepcopy(::ITensorMPS.AbstractMPS)
 ```
 
 ## Properties
 
 ```@docs
-eltype(::ITensors.AbstractMPS)
-flux(::ITensors.AbstractMPS)
-hasqns(::ITensors.AbstractMPS)
-length(::ITensors.AbstractMPS)
-maxlinkdim(::ITensors.AbstractMPS)
+eltype(::ITensorMPS.AbstractMPS)
+flux(::ITensorMPS.AbstractMPS)
+hasqns(::ITensorMPS.AbstractMPS)
+length(::ITensorMPS.AbstractMPS)
+maxlinkdim(::ITensorMPS.AbstractMPS)
 ```
 
 ## Obtaining and finding indices
 
 ```@docs
-siteinds(::typeof(commoninds), ::ITensors.AbstractMPS, ::ITensors.AbstractMPS, ::Int)
-siteinds(::typeof(uniqueinds), ::ITensors.AbstractMPS, ::ITensors.AbstractMPS, ::Int)
+siteinds(::typeof(commoninds), ::ITensorMPS.AbstractMPS, ::ITensorMPS.AbstractMPS, ::Int)
+siteinds(::typeof(uniqueinds), ::ITensorMPS.AbstractMPS, ::ITensorMPS.AbstractMPS, ::Int)
 findsite
 findsites
 firstsiteinds
-linkind(::ITensors.AbstractMPS,::Int)
+linkind(::ITensorMPS.AbstractMPS,::Int)
 siteind(::MPS, ::Int)
 siteind(::typeof(first), ::MPS, ::Int)
 siteinds(::MPS)
 siteind(::MPO, ::Int)
 siteinds(::MPO)
-siteinds(::ITensors.AbstractMPS, ::Int)
+siteinds(::ITensorMPS.AbstractMPS, ::Int)
 ```
 
 ## Priming and tagging
 
 ```@docs
-prime(::ITensors.AbstractMPS)
-prime(::typeof(siteinds), ::ITensors.AbstractMPS)
-prime(::typeof(linkinds), ::ITensors.AbstractMPS)
-prime(::typeof(siteinds), ::typeof(commoninds), ::ITensors.AbstractMPS, ::ITensors.AbstractMPS)
-prime(::typeof(siteinds), ::typeof(uniqueinds), ::ITensors.AbstractMPS, ::ITensors.AbstractMPS)
-
-swapprime(::ITensors.AbstractMPS, args...; kwargs...)
-
-setprime(::ITensors.AbstractMPS)
-setprime(::typeof(siteinds), ::ITensors.AbstractMPS)
-setprime(::typeof(linkinds), ::ITensors.AbstractMPS)
-setprime(::typeof(siteinds), ::typeof(commoninds), ::ITensors.AbstractMPS, ::ITensors.AbstractMPS)
-setprime(::typeof(siteinds), ::typeof(uniqueinds), ::ITensors.AbstractMPS, ::ITensors.AbstractMPS)
-
-noprime(::ITensors.AbstractMPS)
-noprime(::typeof(siteinds), ::ITensors.AbstractMPS)
-noprime(::typeof(linkinds), ::ITensors.AbstractMPS)
-noprime(::typeof(siteinds), ::typeof(commoninds), ::ITensors.AbstractMPS, ::ITensors.AbstractMPS)
-noprime(::typeof(siteinds), ::typeof(uniqueinds), ::ITensors.AbstractMPS, ::ITensors.AbstractMPS)
-
-addtags(::ITensors.AbstractMPS)
-addtags(::typeof(siteinds), ::ITensors.AbstractMPS)
-addtags(::typeof(linkinds), ::ITensors.AbstractMPS)
-addtags(::typeof(siteinds), ::typeof(commoninds), ::ITensors.AbstractMPS, ::ITensors.AbstractMPS)
-addtags(::typeof(siteinds), ::typeof(uniqueinds), ::ITensors.AbstractMPS, ::ITensors.AbstractMPS)
-
-removetags(::ITensors.AbstractMPS)
-removetags(::typeof(siteinds), ::ITensors.AbstractMPS)
-removetags(::typeof(linkinds), ::ITensors.AbstractMPS)
-removetags(::typeof(siteinds), ::typeof(commoninds), ::ITensors.AbstractMPS, ::ITensors.AbstractMPS)
-removetags(::typeof(siteinds), ::typeof(uniqueinds), ::ITensors.AbstractMPS, ::ITensors.AbstractMPS)
-
-replacetags(::ITensors.AbstractMPS)
-replacetags(::typeof(siteinds), ::ITensors.AbstractMPS)
-replacetags(::typeof(linkinds), ::ITensors.AbstractMPS)
-replacetags(::typeof(siteinds), ::typeof(commoninds), ::ITensors.AbstractMPS, ::ITensors.AbstractMPS)
-replacetags(::typeof(siteinds), ::typeof(uniqueinds), ::ITensors.AbstractMPS, ::ITensors.AbstractMPS)
-
-settags(::ITensors.AbstractMPS)
-settags(::typeof(siteinds), ::ITensors.AbstractMPS)
-settags(::typeof(linkinds), ::ITensors.AbstractMPS)
-settags(::typeof(siteinds), ::typeof(commoninds), ::ITensors.AbstractMPS, ::ITensors.AbstractMPS)
-settags(::typeof(siteinds), ::typeof(uniqueinds), ::ITensors.AbstractMPS, ::ITensors.AbstractMPS)
+prime(::ITensorMPS.AbstractMPS)
+prime(::typeof(siteinds), ::ITensorMPS.AbstractMPS)
+prime(::typeof(linkinds), ::ITensorMPS.AbstractMPS)
+prime(::typeof(siteinds), ::typeof(commoninds), ::ITensorMPS.AbstractMPS, ::ITensorMPS.AbstractMPS)
+prime(::typeof(siteinds), ::typeof(uniqueinds), ::ITensorMPS.AbstractMPS, ::ITensorMPS.AbstractMPS)
+
+swapprime(::ITensorMPS.AbstractMPS, args...; kwargs...)
+
+setprime(::ITensorMPS.AbstractMPS)
+setprime(::typeof(siteinds), ::ITensorMPS.AbstractMPS)
+setprime(::typeof(linkinds), ::ITensorMPS.AbstractMPS)
+setprime(::typeof(siteinds), ::typeof(commoninds), ::ITensorMPS.AbstractMPS, ::ITensorMPS.AbstractMPS)
+setprime(::typeof(siteinds), ::typeof(uniqueinds), ::ITensorMPS.AbstractMPS, ::ITensorMPS.AbstractMPS)
+
+noprime(::ITensorMPS.AbstractMPS)
+noprime(::typeof(siteinds), ::ITensorMPS.AbstractMPS)
+noprime(::typeof(linkinds), ::ITensorMPS.AbstractMPS)
+noprime(::typeof(siteinds), ::typeof(commoninds), ::ITensorMPS.AbstractMPS, ::ITensorMPS.AbstractMPS)
+noprime(::typeof(siteinds), ::typeof(uniqueinds), ::ITensorMPS.AbstractMPS, ::ITensorMPS.AbstractMPS)
+
+addtags(::ITensorMPS.AbstractMPS)
+addtags(::typeof(siteinds), ::ITensorMPS.AbstractMPS)
+addtags(::typeof(linkinds), ::ITensorMPS.AbstractMPS)
+addtags(::typeof(siteinds), ::typeof(commoninds), ::ITensorMPS.AbstractMPS, ::ITensorMPS.AbstractMPS)
+addtags(::typeof(siteinds), ::typeof(uniqueinds), ::ITensorMPS.AbstractMPS, ::ITensorMPS.AbstractMPS)
+
+removetags(::ITensorMPS.AbstractMPS)
+removetags(::typeof(siteinds), ::ITensorMPS.AbstractMPS)
+removetags(::typeof(linkinds), ::ITensorMPS.AbstractMPS)
+removetags(::typeof(siteinds), ::typeof(commoninds), ::ITensorMPS.AbstractMPS, ::ITensorMPS.AbstractMPS)
+removetags(::typeof(siteinds), ::typeof(uniqueinds), ::ITensorMPS.AbstractMPS, ::ITensorMPS.AbstractMPS)
+
+replacetags(::ITensorMPS.AbstractMPS)
+replacetags(::typeof(siteinds), ::ITensorMPS.AbstractMPS)
+replacetags(::typeof(linkinds), ::ITensorMPS.AbstractMPS)
+replacetags(::typeof(siteinds), ::typeof(commoninds), ::ITensorMPS.AbstractMPS, ::ITensorMPS.AbstractMPS)
+replacetags(::typeof(siteinds), ::typeof(uniqueinds), ::ITensorMPS.AbstractMPS, ::ITensorMPS.AbstractMPS)
+
+settags(::ITensorMPS.AbstractMPS)
+settags(::typeof(siteinds), ::ITensorMPS.AbstractMPS)
+settags(::typeof(linkinds), ::ITensorMPS.AbstractMPS)
+settags(::typeof(siteinds), ::typeof(commoninds), ::ITensorMPS.AbstractMPS, ::ITensorMPS.AbstractMPS)
+settags(::typeof(siteinds), ::typeof(uniqueinds), ::ITensorMPS.AbstractMPS, ::ITensorMPS.AbstractMPS)
 ```
 
 ## Operations
 
 ```@docs
 expect(::MPS, ::Any)
 correlation_matrix(::MPS, ::AbstractString, ::AbstractString)
-dag(::ITensors.AbstractMPS)
-dense(::ITensors.AbstractMPS)
-movesite(::ITensors.AbstractMPS, ::Pair{Int, Int};orthocenter::Int,kwargs...)
+dag(::ITensorMPS.AbstractMPS)
+dense(::ITensorMPS.AbstractMPS)
+movesite(::ITensorMPS.AbstractMPS, ::Pair{Int, Int};orthocenter::Int,kwargs...)
 orthogonalize!
 replacebond!(::MPS, ::Int, ::ITensor)
 sample(::MPS)
 sample!(::MPS)
 sample(::MPO)
-swapbondsites(::ITensors.AbstractMPS, ::Int; kwargs...)
+swapbondsites(::ITensorMPS.AbstractMPS, ::Int; kwargs...)
 truncate!
 ```
 
 ## Gate evolution
 
 ```@docs
-product(::ITensor, ::ITensors.AbstractMPS)
-product(::Vector{ITensor}, ::ITensors.AbstractMPS)
+product(::ITensor, ::ITensorMPS.AbstractMPS)
+product(::Vector{ITensor}, ::ITensorMPS.AbstractMPS)
 ```
 
 ## Algebra Operations
 
 ```@docs
-inner(::MPST, ::MPST) where {MPST <: ITensors.AbstractMPS}
-dot(::MPST, ::MPST) where {MPST <: ITensors.AbstractMPS}
-loginner(::MPST, ::MPST) where {MPST <: ITensors.AbstractMPS}
-logdot(::MPST, ::MPST) where {MPST <: ITensors.AbstractMPS}
+inner(::MPST, ::MPST) where {MPST <: ITensorMPS.AbstractMPS}
+dot(::MPST, ::MPST) where {MPST <: ITensorMPS.AbstractMPS}
+loginner(::MPST, ::MPST) where {MPST <: ITensorMPS.AbstractMPS}
+logdot(::MPST, ::MPST) where {MPST <: ITensorMPS.AbstractMPS}
 inner(::MPS, ::MPO, ::MPS)
 dot(::MPS, ::MPO, ::MPS)
 inner(::MPO, ::MPS, ::MPO, ::MPS)
 dot(::MPO, ::MPS, ::MPO, ::MPS)
-norm(::ITensors.AbstractMPS)
-normalize(::ITensors.AbstractMPS)
-normalize!(::ITensors.AbstractMPS)
-lognorm(::ITensors.AbstractMPS)
-+(::ITensors.AbstractMPS...)
+norm(::ITensorMPS.AbstractMPS)
+normalize(::ITensorMPS.AbstractMPS)
+normalize!(::ITensorMPS.AbstractMPS)
+lognorm(::ITensorMPS.AbstractMPS)
++(::ITensorMPS.AbstractMPS...)
 contract(::MPO, ::MPS)
 apply(::MPO, ::MPS)
 contract(::MPO, ::MPO)