doc update

titaschanda · Dec 20, 2023 · 8df78f1 · 8df78f1
1 parent 6e664ed
commit 8df78f1
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 0 deletions.
diff --git a/docs/make.jl b/docs/make.jl
@@ -10,6 +10,9 @@ settings = Dict(
     :pages =>
         [
             "Introduction" => "index.md"
+            "MPS based methods" => [
+                "StateEnvs" => "mps/state_envs.md"
+                ]
             "DMRG" => "dmrg.md"
         ],
     :format => Documenter.HTML(; assets=["assets/favicon.ico"], prettyurls=false),

diff --git a/docs/src/mps/state_envs.md b/docs/src/mps/state_envs.md
@@ -0,0 +1,8 @@
+# `StateEnvs`: A container to store the MPS and its environment
+
+At the lowest-level of abstraction, TeNLib defines `StateEnvs` to hold an MPS and its environment to be modified in place.
+Skip this part if you want to avoid lower-level abstraction.
+
+```@autodocs
+Pages   = ["mps/state_envs.jl"]
+```