update docs

vda-lab · Jan 13, 2025 · 1dc9b84 · 1dc9b84
1 parent db0e976
commit 1dc9b84
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 3 deletions.
diff --git a/.github/workflows/Docs.yml b/.github/workflows/Docs.yml
@@ -43,7 +43,7 @@ jobs:
         run: |
           cd notebooks
           for FILE in *.ipynb; do 
-            cp $FILE ../docs
+            cp $FILE ../doc
           done
           cd ..
 

diff --git a/doc/reference.rst b/doc/reference.rst
@@ -1,6 +1,9 @@
 API Reference
 =============
 
-.. automodule:: fast_hbcc
-    :members: HBCC, fast_hbcc, BoundaryClusterDetector, find_boundary_sub_clusters
+.. autoclass:: fast_hbcc.HBCC
+    :members:
+
 
+.. autoclass:: fast_hbcc.BoundaryClusterDetector
+    :members: HBCC, fast_hbcc, BoundaryClusterDetector, find_boundary_sub_clusters