Added tutorial ipynb to docs

- Tutorial is from TVS colloquium - Also renamed usage to quick start
sidchaini · Dec 5, 2024 · 195263c · 195263c
1 parent 0b3f2a1
commit 195263c
Show file tree

Hide file tree

Showing 5 changed files with 1,939 additions and 5 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -16,7 +16,7 @@
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
-extensions = ["sphinx.ext.autodoc", "sphinx.ext.napoleon", "sphinx_favicon"]
+extensions = ["sphinx.ext.autodoc", "sphinx.ext.napoleon", "sphinx_favicon", "nbsphinx"]
 
 templates_path = ["_templates"]
 exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", "**.ipynb_checkpoints"]

diff --git a/docs/index.rst b/docs/index.rst
@@ -17,10 +17,10 @@ To install DistClassiPy, run the following command:
 
     pip install distclassipy
 
-Usage
+Quick Start
 -----
 
-Here's a quick example to get you started with DistClassiPy:
+Here's a quick start guide to using DistClassiPy:
 
 .. code-block:: python
 
@@ -64,8 +64,20 @@ API Documentation
 -----------------
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 1
+   :caption: Get Started
+
+   tutorial
+
+.. toctree::
+   :maxdepth: 1
    :caption: API Reference
 
    classifier
-   distances
+   distances
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Index
+
+   genindex
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -4,3 +4,4 @@ myst_parser
 sphinx-book-theme
 sphinx-favicon
 sphinx-copybutton
+nbsphinx
diff --git a/docs/tutorial.ipynb b/docs/tutorial.ipynb
diff --git a/docs/tutorial.rst b/docs/tutorial.rst
@@ -0,0 +1,9 @@
+   .. _tutorial:
+
+   Tutorial
+   ========
+
+   .. toctree::
+      :maxdepth: 2
+
+   .. nbsphinx:: tutorial.ipynb