Minor changes and corrections to tutorials in the API (#479)

* minor changes to tutos doc *added missing focus tutorials *added hyperedges in depth tutorial * Minor fixes in tutos * minor fix * minor fixes * recipe for colours of different hyperedges * added missing cell in in depth 2 * corrections by max
xgi-org · Oct 19, 2023 · 536f592 · 536f592
1 parent 31b0fc8
commit 536f592
Show file tree

Hide file tree

Showing 10 changed files with 301 additions and 336 deletions.
diff --git a/docs/source/api/recipes/recipes.ipynb b/docs/source/api/recipes/recipes.ipynb
diff --git a/docs/source/api/tutorials/In Depth 1 - Drawing nodes.ipynb b/docs/source/api/tutorials/In Depth 1 - Drawing nodes.ipynb
diff --git a/docs/source/api/tutorials/In Depth 2 - Drawing hyperedges.ipynb b/docs/source/api/tutorials/In Depth 2 - Drawing hyperedges.ipynb
diff --git a/docs/source/api/tutorials/XGI in 1 minute.ipynb b/docs/source/api/tutorials/XGI in 1 minute.ipynb
diff --git a/docs/source/api/tutorials/XGI in 15 minutes.ipynb b/docs/source/api/tutorials/XGI in 15 minutes.ipynb
diff --git a/docs/source/api/tutorials/XGI in 5 minutes.ipynb b/docs/source/api/tutorials/XGI in 5 minutes.ipynb
diff --git a/docs/source/api/tutorials/case_studies.rst b/docs/source/api/tutorials/case_studies.rst
@@ -3,7 +3,7 @@ Case studies
 ##################
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 1
 
    case_study_zhang2022
    simplicial_kuramoto_example
diff --git a/docs/source/api/tutorials/focus_tutorials.rst b/docs/source/api/tutorials/focus_tutorials.rst
@@ -0,0 +1,16 @@
+##################
+ Focus tutorials
+##################
+
+
+ .. toctree::
+    :maxdepth: 1
+
+    Tutorial 1 - Basic Hypergraph Functionality
+    Tutorial 2 - Read and Write
+    Tutorial 3 - Basic simplicial complex usage
+    Tutorial 4 - Generative_Models
+    Tutorial 5 - Plotting
+    Tutorial 6 - Statistics
+    Tutorial 7 - Convex hulls hypergraph plotting
+    Tutorial 8 - Directed Hypergraphs
diff --git a/docs/source/api/tutorials/in_depth.rst b/docs/source/api/tutorials/in_depth.rst
@@ -5,4 +5,5 @@ In depth tutorials
 .. toctree::
    :maxdepth: 1
 
-   In Depth 1 - Drawing nodes
+   In Depth 1 - Drawing nodes
+   In Depth 2 - Drawing hyperedges
diff --git a/docs/source/api/tutorials/simplicial_kuramoto_example.ipynb b/docs/source/api/tutorials/simplicial_kuramoto_example.ipynb