move surgery to recipes

ASEM000 · Apr 11, 2024 · 43acd11 · 43acd11
1 parent bea703f
commit 43acd11
Show file tree

Hide file tree

Showing 6 changed files with 19 additions and 16 deletions.
diff --git a/docs/API/sepes.rst b/docs/API/sepes.rst
@@ -2,7 +2,7 @@
 =============================
 
 .. note::
-    `sepes <https://sepes.readthedocs.io/>`_ API is fully re-exported under the ``serket`` namespace.
+    `sepes <https://sepes.readthedocs.io/>`_ for tree API is fully re-exported under the ``serket`` namespace.
     `Check the docs <https://sepes.readthedocs.io/>`_ for full details.
 
 .. toctree::

diff --git a/docs/core_guides.rst b/docs/core_guides.rst
@@ -6,7 +6,6 @@
     :caption: Core guides
     :maxdepth: 1
 
-    notebooks/[guides][core]surgery
     notebooks/[guides][core]checkpointing
     notebooks/[guides][core]distributed_training
     notebooks/[guides][core]mixed_precision

diff --git a/docs/index.rst b/docs/index.rst
@@ -64,7 +64,7 @@ Install from github::
     core_guides
     other_guides
     interoperability
-    recipes
+    tree_recipes
 
 .. currentmodule:: serket
 

diff --git a/docs/notebooks/[guides][core]surgery.ipynb → docs/notebooks/[recipes]surgery.ipynb b/docs/notebooks/[guides][core]surgery.ipynb → docs/notebooks/[recipes]surgery.ipynb
diff --git a/docs/recipes.rst b/docs/recipes.rst
diff --git a/docs/tree_recipes.rst b/docs/tree_recipes.rst
@@ -0,0 +1,17 @@
+🍳  Tree recipes
+----------------
+
+.. note::
+    `sepes <https://sepes.readthedocs.io/>`_ for tree API is fully re-exported under the ``serket`` namespace.
+    `Check the docs <https://sepes.readthedocs.io/>`_ for full details.
+
+.. toctree::
+    :caption: recipes
+    :maxdepth: 1
+
+    notebooks/[recipes]surgery
+    notebooks/[recipes]fields
+    notebooks/[recipes]intermediates
+    notebooks/[recipes]misc
+    notebooks/[recipes]sharing
+    notebooks/[recipes]transformations