fix: linear solve docs error remains

metaopt · Benjamin-eecs · Sep 22, 2022 · Sep 9, 2022 · Sep 9, 2022 · Sep 10, 2022
commit 0d76585b99ffc56d897cfb211cce829cc4acd85d
diff --git a/docs/source/api/api.rst b/docs/source/api/api.rst
@@ -147,22 +147,21 @@ Custom solvers
 
 ------
 
+.. Linear system solving
+.. =====================
 
-Linear system solving
-=====================
-
-.. currentmodule:: torchopt._src.linear_solve
+.. .. currentmodule:: torchopt._src.linear_solve
 
-.. autosummary::
+.. .. autosummary::
 
-    solve_cg
-    solve_normal_cg
+..     solve_cg
+..     solve_normal_cg
 
-Indirect solvers
-~~~~~~~~~~~~~~~~
+.. Indirect solvers
+.. ~~~~~~~~~~~~~~~~
 
-.. autofunction:: solve_cg
-.. autofunction:: solve_normal_cg
+.. .. autofunction:: solve_cg
+.. .. autofunction:: solve_normal_cg
 
 ------
 
@@ -182,6 +181,8 @@ Hook
 .. autofunction:: register_hook
 .. autofunction:: zero_nan_hook
 
+------
+
 Gradient Transformation
 =======================
 

diff --git a/docs/source/spelling_wordlist.txt b/docs/source/spelling_wordlist.txt
@@ -78,3 +78,5 @@ Loshchilov
 pytree
 booleans
 subtrees
+optimality
+argnums