docs organization

ASEM000 · Mar 29, 2024 · 69bbcfe · 69bbcfe
1 parent fb79837
commit 69bbcfe
Show file tree

Hide file tree

Showing 7 changed files with 44 additions and 30 deletions.
diff --git a/docs/API/constructor.rst b/docs/API/constructor.rst
@@ -0,0 +1,10 @@
+🎯 Constructor utils API
+=============================
+
+
+.. currentmodule:: sepes 
+
+.. autofunction:: field
+.. autofunction:: fields
+.. autofunction:: autoinit
+.. autofunction:: leafwise
diff --git a/docs/API/core.rst b/docs/API/core.rst
diff --git a/docs/API/masking.rst b/docs/API/masking.rst
@@ -3,6 +3,6 @@
 
 .. currentmodule:: sepes 
 
-.. autofunction:: is_nondiff
+.. autofunction:: is_masked
 .. autofunction:: tree_mask
 .. autofunction:: tree_unmask
diff --git a/docs/API/module.rst b/docs/API/module.rst
@@ -0,0 +1,10 @@
+🎯 Module API
+=============================
+
+
+.. currentmodule:: sepes 
+
+.. autoclass:: TreeClass 
+    :members:
+        at
+
diff --git a/docs/API/sepes.rst b/docs/API/sepes.rst
@@ -5,7 +5,9 @@
    :maxdepth: 2
    :caption: API Documentation
 
-   core
+   module
    masking
+   tree
+   constructor
    pretty_print
    backend
diff --git a/docs/API/tree.rst b/docs/API/tree.rst
@@ -0,0 +1,17 @@
+🎯 Tree utils API
+=============================
+
+
+.. currentmodule:: sepes 
+
+.. autoclass:: at
+    :members:
+        get,
+        set,
+        apply,
+        scan,
+        reduce,
+        pluck,
+
+.. autofunction:: value_and_tree
+.. autofunction:: bcmap
diff --git a/sepes/__init__.py b/sepes/__init__.py
@@ -23,8 +23,6 @@
 __all__ = (
     # module utils
     "TreeClass",
-    "value_and_tree",
-    "leafwise",
     # pprint utils
     "tree_diagram",
     "tree_repr",
@@ -34,14 +32,15 @@
     "is_masked",
     "tree_unmask",
     "tree_mask",
-    # indexing utils
-    "at",
     # tree utils
+    "at",
     "bcmap",
+    "value_and_tree",
     # construction utils
     "field",
     "fields",
     "autoinit",
+    "leafwise",
     # backend utils
     "backend_context",
 )