docs

ASEM000 · Jul 25, 2023 · 0d821a0 · 0d821a0
1 parent bd78a5f
commit 0d821a0
Show file tree

Hide file tree

Showing 6 changed files with 33 additions and 30 deletions.
diff --git a/docs/API/pytreeclass.rst b/docs/API/pytreeclass.rst
@@ -1,13 +1,11 @@
-``PyTreeClass`` exported API
+``PyTreeClass`` API
 =============================
 
-Serket relies on ``PyTreeClass`` :ref: for its module system (``TreeClass``). 
-The entire ``PyTreeClass`` is reexported for convinence and is defiend below. 
-
 .. toctree::
    :maxdepth: 2
    :caption: API Documentation
 
-   pytreeclass_core
-   pytreeclass_advanced_api
-   pytreeclass_pretty_print
+   pytreeclass/core
+   pytreeclass/masking
+   pytreeclass/advanced_api
+   pytreeclass/pretty_print
diff --git a/docs/API/pytreeclass_advanced_api.rst → docs/API/pytreeclass/advanced_api.rst b/docs/API/pytreeclass_advanced_api.rst → docs/API/pytreeclass/advanced_api.rst
@@ -1,6 +1,6 @@
-Advanced API
+➕ Advanced API
 ---------------------------------------
-.. currentmodule:: serket
+.. currentmodule:: pytreeclass
 
 .. autofunction:: bcmap
 .. autoclass:: Partial

diff --git a/docs/API/pytreeclass_core.rst → docs/API/pytreeclass/core.rst b/docs/API/pytreeclass_core.rst → docs/API/pytreeclass/core.rst
@@ -1,7 +1,8 @@
-Core API
+🎯 Core API
 =============================
 
-.. currentmodule:: serket 
+
+.. currentmodule:: pytreeclass 
 
 .. autoclass:: TreeClass 
 .. autoclass:::members: at

diff --git a/docs/API/pytreeclass/masking.rst b/docs/API/pytreeclass/masking.rst
@@ -0,0 +1,11 @@
+💼 Masking API
+----------------------------------------------
+
+.. currentmodule:: pytreeclass 
+
+.. autofunction:: is_nondiff
+.. autofunction:: freeze
+.. autofunction:: unfreeze
+.. autofunction:: is_frozen
+.. autofunction:: tree_mask
+.. autofunction:: tree_unmask
diff --git a/docs/API/pytreeclass/pretty_print.rst b/docs/API/pytreeclass/pretty_print.rst
@@ -0,0 +1,12 @@
+🎨 Pretty printing API
+----------------------------------------------
+
+.. currentmodule:: pytreeclass 
+
+.. autofunction:: tree_diagram
+.. autofunction:: tree_graph
+.. autofunction:: tree_mermaid 
+.. autofunction:: tree_repr 
+.. autofunction:: tree_str
+.. autofunction:: tree_summary
+.. autofunction:: tree_repr_with_trace
diff --git a/docs/API/pytreeclass_pretty_print.rst b/docs/API/pytreeclass_pretty_print.rst