Merge pull request #8 from adamingas/development

fix: add overview notebook to documentation and ability to render mat…
adamingas · Jan 17, 2024 · 047267e · 047267e
2 parents 37c4698 + d7d0d5a
commit 047267e
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 1 deletion.
diff --git a/docs/conf.py b/docs/conf.py
@@ -30,7 +30,15 @@
 autoapi_dirs = ["../ordinalgbt"] # location to parse for API reference
 html_theme = "sphinx_rtd_theme"
 exclude_patterns = []
-nb_execution_mode = "off"
+myst_enable_extensions = [
+ "amsmath",
+ "colon_fence",
+ "deflist",
+ "dollarmath",
+ "html_image",
+]
+
+nb_execution_mode = "cache"
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 

diff --git a/docs/index.md b/docs/index.md
@@ -5,6 +5,7 @@
 :maxdepth: 1
 :hidden:
 
+motivation.ipynb
 comparison_with_classifiers.ipynb
 shap.ipynb
 maths