Update docs library, fix typos

QuantumKitHub · May 1, 2024 · 6ca5b19 · 6ca5b19
1 parent adcf24a
commit 6ca5b19
Show file tree

Hide file tree

Showing 5 changed files with 10 additions and 6 deletions.
diff --git a/docs/Project.toml b/docs/Project.toml
@@ -1,5 +1,6 @@
 [deps]
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
+PEPSKit = "52969e89-939e-4361-9b68-9bc7cde4bdeb"
 
 [compat]
 Documenter = "0.27"
diff --git a/docs/make.jl b/docs/make.jl
@@ -25,4 +25,4 @@ makedocs(;
     ],
 )
 
-deploydocs(; repo="https://github.com/quantumghent/PEPSKit.jl.git")
+# deploydocs(; repo="https://github.com/quantumghent/PEPSKit.jl.git")
diff --git a/docs/src/lib/lib.md b/docs/src/lib/lib.md
@@ -1 +1,5 @@
-Coming soon.
+# Library
+
+```@autodocs
+Modules = [PEPSKit, PEPSKit.Defaults]
+```
diff --git a/src/PEPSKit.jl b/src/PEPSKit.jl
@@ -45,8 +45,7 @@ Module containing default values that represent typical algorithm parameters.
 - `ctmrg_maxiter = 100`: Maximal number of CTMRG iterations per run
 - `ctmrg_miniter = 4`: Minimal number of CTMRG carried out
 - `ctmrg_tol = 1e-12`: Tolerance checking singular value and norm convergence
-- `fpgrad_maxiter = 100`: Maximal number of iterations for computing the CTMRG
-fixed-point gradient
+- `fpgrad_maxiter = 100`: Maximal number of iterations for computing the CTMRG fixed-point gradient
 - `fpgrad_tol = 1e-6`: Convergence tolerance for the fixed-point gradient iteration
 
 """

diff --git a/src/operators/infinitepepo.jl b/src/operators/infinitepepo.jl
@@ -113,8 +113,8 @@ function InfinitePEPO(d::Integer, D::Integer)
 end
 
 """
-InfinitePEPO(d, D, L)
-InfinitePEPO(d, D, (Lx, Ly, Lz)))
+    InfinitePEPO(d, D, L)
+    InfinitePEPO(d, D, (Lx, Ly, Lz)))
 
 Allow users to pass in integers and specify unit cell.
 """
-Original file line number
+Diff line change
@@ Expand Up / @@ -25,4 +25,4 @@ makedocs(; @@
         ],
     )
-    deploydocs(; repo="https://github.com/quantumghent/PEPSKit.jl.git")
+    # deploydocs(; repo="https://github.com/quantumghent/PEPSKit.jl.git")