Execute code snippets in markdown (#109)

Use myst-nb to execute code snippets. Add section on polars integration.
BiocPy · Jun 10, 2024 · 5b4cb4f · 5b4cb4f
1 parent b5646a1
commit 5b4cb4f
Show file tree

Hide file tree

Showing 4 changed files with 413 additions and 649 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -72,7 +72,6 @@
     "sphinx.ext.ifconfig",
     "sphinx.ext.mathjax",
     "sphinx.ext.napoleon",
-    "sphinx_autodoc_typehints",
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -119,13 +118,10 @@
 # If you don’t need the separation provided between version and release,
 # just set them both to the same value.
 
-if "SPHINX_DOC_VERSION_MANUAL" in os.environ:
-    version = os.getenv("SPHINX_DOC_VERSION_MANUAL", None)
-else:
-    try:
-        from biocframe import __version__ as version
-    except ImportError:
-        version = ""
+try:
+    from biocframe import __version__ as version
+except ImportError:
+    version = ""
 
 if not version or version.lower() == "unknown":
     version = os.getenv("READTHEDOCS_VERSION", "unknown")  # automatically set by RTD

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