Embed Jupyter Notebook in the docs

aadya940 · Aug 5, 2024 · 72b3bc3 · 72b3bc3
1 parent 976e4c0
commit 72b3bc3
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 2 deletions.
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -36,6 +36,7 @@
     "sphinx.ext.githubpages",
     "sphinx.ext.extlinks",
     "sphinx_autodoc_typehints",
+    "nbsphinx",
 ]
 
 source_suffix = {

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -10,7 +10,12 @@ Examples
 --------
 
 You can see example usage of chainopy here: 
-`demo.ipynb <https://github.com/aadya940/chainopy/blob/master/examples/demo.ipynb>`_
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Examples:
+
+   ../../examples/demo.ipynb
 
 Autosummary
 -----------

diff --git a/requirements_doc.txt b/requirements_doc.txt
@@ -2,4 +2,5 @@ sphinx
 sphinx-rtd-theme
 furo
 myst-parser
-sphinx-autodoc-typehints
+sphinx-autodoc-typehints
+nbsphinx