add mockimport

KindXiaoming · Apr 29, 2024 · 4cad580 · 4cad580
1 parent f032e48
commit 4cad580
Show file tree

Hide file tree

Showing 2 changed files with 29 additions and 4 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -40,7 +40,11 @@ def skip(app, what, name, obj, would_skip, options):
 def setup(app):
     app.connect("autodoc-skip-member", skip)
 
-
+autodoc_mock_imports = ["sphinx_rtd_theme",
+                        "sphinx.ext.autodoc",
+                        "sphinx.ext.autosectionlabel"
+                        ]
+
 
 source_suffix = [".rst", ".md"]
 #source_suffix = [".rst", ".md", ".ipynb"]

diff --git a/docs/kan.rst b/docs/kan.rst
@@ -1,19 +1,33 @@
+kan package
+===========
+
+Submodules
+----------
+
 kan.KAN module
 --------------
 
 .. automodule:: kan.KAN
    :members:
    :undoc-members:
    :show-inheritance:
-   
+
 kan.KANLayer module
 -------------------
 
 .. automodule:: kan.KANLayer
    :members:
    :undoc-members:
    :show-inheritance:
-
+
+kan.LBFGS module
+----------------
+
+.. automodule:: kan.LBFGS
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 kan.Symbolic\_KANLayer module
 -----------------------------
 
@@ -29,7 +43,7 @@ kan.spline module
    :members:
    :undoc-members:
    :show-inheritance:
-   
+
 kan.utils module
 ----------------
 
@@ -38,3 +52,10 @@ kan.utils module
    :undoc-members:
    :show-inheritance:
 
+Module contents
+---------------
+
+.. automodule:: kan
+   :members:
+   :undoc-members:
+   :show-inheritance: