From d7d0d5ae3570b90a77f5770e9235bd870f373a83 Mon Sep 17 00:00:00 2001 From: adamingas Date: Wed, 17 Jan 2024 22:18:19 +0000 Subject: [PATCH] fix: add overview notebook to documentation and ability to render maths for notebooks --- docs/conf.py | 10 +++++++++- docs/index.md | 1 + 2 files changed, 10 insertions(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index 277bc63..30d82b6 100644 --- 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 index cf14380..ffcc8c0 100644 --- a/docs/index.md +++ b/docs/index.md @@ -5,6 +5,7 @@ :maxdepth: 1 :hidden: +motivation.ipynb comparison_with_classifiers.ipynb shap.ipynb maths