Update documenter to v1

Author: lkdvos

docs/Project.toml

@@ -1,5 +1,7 @@
 [deps]
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
+MPSKit = "bb1c41ca-d63c-52ed-829e-0820dda26502"
+MPSKitModels = "ca635005-6f8c-4cd1-b51d-8491250ef2ab"
 
 [compat]
-Documenter = "0.25 - 0.30"
+Documenter = "1"

docs/make.jl

@@ -1,3 +1,12 @@
+# if examples is not the current active environment, switch to it
+if Base.active_project() != joinpath(@__DIR__, "Project.toml")
+    using Pkg
+    Pkg.activate(@__DIR__)
+    Pkg.develop(PackageSpec(; path=(@__DIR__) * "/../"))
+    Pkg.resolve()
+    Pkg.instantiate()
+end
+
 using Documenter
 using MPSKitModels
 
@@ -13,6 +22,7 @@ makedocs(;
                              "man/mpoham.md",
                              "man/lattices.md",
                              "man/models.md"],
-                "Index" => "package_index.md"])
+                "Index" => "package_index.md"],
+         checkdocs=:public)
 
 deploydocs(; repo="github.com/QuantumKitHub/MPSKitModels.jl.git")

docs/src/man/lattices.md

@@ -10,6 +10,8 @@ In order to facilitate this mapping, the combination of the `@mpoham` macro and
 ```@docs
 AbstractLattice
 FiniteChain
+FiniteCylinder
+FiniteStrip
 InfiniteChain
 InfiniteCylinder
 InfiniteHelix
@@ -26,6 +28,7 @@ LatticePoint
 linearize_index
 vertices
 nearest_neighbours
+next_nearest_neighbours
 bipartition
 ```
 
@@ -39,4 +42,4 @@ Any mapping of linear indices can be used, but the following patterns can be hel
 ```@docs
 backandforth_pattern
 frontandback_pattern
-```
+```

docs/src/man/models.md

@@ -9,10 +9,12 @@ CurrentModule = MPSKitModels
 ```@docs
 transverse_field_ising
 kitaev_model
+quantum_potts
 heisenberg_XXX
 heisenberg_XXZ
 heisenberg_XYZ
 bilinear_biquadratic_model
+tj_model
 hubbard_model
 bose_hubbard_model
 quantum_chemistry_hamiltonian
@@ -25,4 +27,4 @@ classical_ising
 sixvertex
 hard_hexagon
 qstate_clock
-```
+```

docs/src/man/mpoham.md

@@ -1,7 +1,7 @@
 # The `@mpoham` macro
 
 ```@meta
-CurrentModule = TensorKit
+CurrentModule = MPSKitModels
 ```
 
 When dealing with (quasi-) one-dimensional systems that are defined by a sum of local operators, a convenient representation exists in terms of a sparse matrix product operator with an upper diagonal structure (`MPOHamiltonian`).
@@ -10,3 +10,10 @@ The generation of such an object starting from a sum of local operators is facil
 ```@docs
 @mpoham
 ```
+
+Internally, the macro generates operators that have some knowledge of the lattice structure, through the following structures:
+
+```@docs
+LocalOperator
+SumOfLocalOperators
+```

docs/src/man/operators.md

@@ -34,6 +34,7 @@ S_zz
 S_plusmin
 S_minplus
 S_exchange
+spinmatrices
 ```
 
 For convenience, the Pauli matrices can also be recovered as ``σⁱ = 2 Sⁱ``.
@@ -62,6 +63,8 @@ Supported values of `symmetry` for the `X` operator are `Trivial` and `ZNIrrep{Q
 potts_X
 potts_Z
 potts_ZZ
+potts_field
+weyl_heisenberg_matrices
 ```
 
 ## Bosonic operators
@@ -102,8 +105,12 @@ c_number
 
 Spinful fermions.
 
-```@docs
-e_plus
-e_min
-e_number
-```
+```@autodocs
+Modules = [MPSKitModels.HubbardOperators]
+```
+
+TJ-model operators.
+
+```@autodocs
+Modules = [MPSKitModels.TJOperators]
+```