Add tutorial to docs (#100)

Tutorial is an IPython notebook built when sphinx generates the html build
BiocPy · Mar 7, 2024 · ffba6b2 · ffba6b2
1 parent 3cdcbe3
commit ffba6b2
Show file tree

Hide file tree

Showing 4 changed files with 645 additions and 2 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -80,7 +80,8 @@
 
 
 # Enable markdown
-extensions.append("myst_parser")
+# extensions.append("myst_parser")
+extensions.append("myst_nb")
 
 # Configure MyST-Parser
 myst_enable_extensions = [

diff --git a/docs/index.md b/docs/index.md
@@ -5,7 +5,7 @@
 ```{toctree}
 :maxdepth: 2
 
-Overview <readme>
+Overview <tutorial.ipynb>
 Module Reference <api/modules>
 Contributions & Help <contributing>
 License <license>

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,8 +1,10 @@
 furo
+myst-nb
 # Requirements file for ReadTheDocs, check .readthedocs.yml.
 # To build the module reference correctly, make sure every external package
 # under `install_requires` in `setup.cfg` is also listed here!
 # sphinx_rtd_theme
 myst-parser[linkify]
 sphinx>=3.2.1
 sphinx-autodoc-typehints
+# nbsphinx