attempt for nested toc structure

xgi-org · Oct 16, 2023 · 9e5a13a · 9e5a13a
1 parent ca647d4
commit 9e5a13a
Show file tree

Hide file tree

Showing 6 changed files with 35 additions and 39 deletions.
diff --git a/docs/source/api/tutorials.rst b/docs/source/api/tutorials.rst
@@ -1,38 +1,12 @@
+##################
+Tutorials
+##################
+
 .. toctree::
    :maxdepth: 2
-   :caption: Tutorials
-
-   .. toctree::
-      :maxdepth: 2
-      :caption: Getting Started
-
-      tutorials/XGI in 1 minute
-      tutorials/XGI in 5 minutes
-      tutorials/XGI in 15 minutes
-
-   .. toctree::
-      :maxdepth: 2
-      :caption: Focus Tutorials
-
-      tutorials/Tutorial 1 - Basic Hypergraph Functionality
-      tutorials/Tutorial 2 - Read and Write
-      tutorials/Tutorial 3 - Basic simplicial complex usage
-      tutorials/Tutorial 4 - Generative_Models
-      tutorials/Tutorial 5 - Plotting
-      tutorials/Tutorial 6 - Statistics
-      tutorials/Tutorial 7 - Convex hulls hypergraph plotting
-      tutorials/Tutorial 8 - Directed Hypergraphs
-
-   .. toctree::
-      :maxdepth: 2
-      :caption: In-depth Tutorials
-
-      tutorials/In Depth 1 - Drawing nodes
-
-   .. toctree::
-      :maxdepth: 2
-      :caption: Case Studies
 
-      tutorials/case_study_zhang2022
-      tutorials/simplicial_kuramoto_example
+   tutorials/getting_started
+   tutorials/focus_tutorials
+   tutorials/in_depth
+   tutorials/case_studies
 
diff --git a/docs/source/api/tutorials/XGI in 1 minute.ipynb b/docs/source/api/tutorials/XGI in 1 minute.ipynb
@@ -220,11 +220,6 @@
     "\n",
     "Time flies! Don't forget to check out tutorials [here](https://xgi.readthedocs.io/en/stable/api/tutorials.html#)!. And guess what? XGI doesn't stop at hypergraphs — it can handle [simplicial complexes](https://xgi.readthedocs.io/en/stable/api/core/xgi.core.simplicialcomplex.SimplicialComplex.html) and [directed hypergraphs](https://xgi.readthedocs.io/en/stable/api/core/xgi.core.dihypergraph.DiHypergraph.html) too!"
    ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": []
   }
  ],
  "metadata": {

diff --git a/docs/source/api/tutorials/case_studies.rst b/docs/source/api/tutorials/case_studies.rst
@@ -0,0 +1,9 @@
+##################
+Case studies
+##################
+
+.. toctree::
+   :maxdepth: 2
+
+   case_study_zhang2022
+   simplicial_kuramoto_example
diff --git a/docs/source/api/tutorials/focus_tutorials.rst b/docs/source/api/tutorials/focus_tutorials.rst
diff --git a/docs/source/api/tutorials/getting_started.rst b/docs/source/api/tutorials/getting_started.rst
@@ -0,0 +1,10 @@
+##################
+Getting started
+##################
+
+.. toctree::
+   :maxdepth: 1
+
+   XGI in 1 minute
+   XGI in 5 minutes
+   XGI in 15 minutes
diff --git a/docs/source/api/tutorials/in_depth.rst b/docs/source/api/tutorials/in_depth.rst
@@ -0,0 +1,8 @@
+##################
+In depth tutorials
+##################
+
+.. toctree::
+   :maxdepth: 1
+
+   In Depth 1 - Drawing nodes