From 72b3bc349d354e541d98e999b8ec363d8329a4b3 Mon Sep 17 00:00:00 2001 From: aadya940 <aadya@unify.ai> Date: Mon, 5 Aug 2024 20:11:13 +0530 Subject: [PATCH] Embed Jupyter Notebook in the docs --- docs/source/conf.py | 1 + docs/source/index.rst | 7 ++++++- requirements_doc.txt | 3 ++- 3 files changed, 9 insertions(+), 2 deletions(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index 18d9553..106a05c 100644 --- 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 index 9ab64e2..fea660b 100644 --- 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 index 23825e7..6040e4c 100644 --- a/requirements_doc.txt +++ b/requirements_doc.txt @@ -2,4 +2,5 @@ sphinx sphinx-rtd-theme furo myst-parser -sphinx-autodoc-typehints \ No newline at end of file +sphinx-autodoc-typehints +nbsphinx \ No newline at end of file