docs quickstart

Author: tasansal

docs/conf.py

@@ -6,17 +6,21 @@
     "sphinx.ext.autodoc",
     "sphinx.ext.napoleon",
     "sphinx_click",
-    "myst_parser",
     "sphinx_copybutton",
+    "myst_nb",
 ]
+
 autodoc_typehints = "description"
 autodoc_typehints_format = "short"
 autodoc_member_order = "groupwise"
-html_theme = "furo"
 autoclass_content = "both"
 
+html_theme = "furo"
+
 myst_heading_anchors = 2
 
 # sphinx-copybutton configurations
 copybutton_prompt_text = r">>> |\.\.\. |\$ |In \[\d*\]: | {2,5}\.\.\.: | {5,8}: "
 copybutton_prompt_is_regexp = True
+
+nb_execution_mode = "off"

docs/index.md

@@ -13,7 +13,7 @@ end-before: <!-- github-only -->
 hidden:
 maxdepth: 1
 ---
-
+notebooks/quickstart
 usage
 reference
 contributing