diff --git a/README.md b/README.md index 753a341..0c74297 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ a paper on fatty liver disease. ## Installation -Install using pip from [PyPi](https://pypi.org/project/njab) version +Install using pip from [PyPi](https://pypi.org/project/njab) version. ``` pip install njab diff --git a/docs/conf.py b/docs/conf.py index 17f728b..d7cb9fc 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -35,10 +35,16 @@ 'sphinx.ext.autodoc', 'sphinx.ext.autodoc.typehints', 'sphinx.ext.viewcode', - 'myst_parser', + 'myst_nb', 'sphinx.ext.napoleon', ] +# https://myst-nb.readthedocs.io/en/latest/computation/execute.html +nb_execution_mode = "auto" + +myst_enable_extensions = ["dollarmath", "amsmath"] + + # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] diff --git a/docs/index.rst b/docs/index.rst index c07c41c..ec4fa9a 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -9,11 +9,27 @@ functionality used two papers. .. include:: ../README.md :parser: myst_parser.sphinx_ :start-line: 1 -.. :end-line: 22 + + +Try it yourself +--------------- + +The tutorial showcasing most of the basic functionality can be found on the following +pages + +.. toctree:: + :maxdepth: 2 + :caption: Tutorials + + tutorial/explorative_analysis + tutorial/log_reg + +Python Package reference +------------------------ .. toctree:: :maxdepth: 2 - :caption: Python Package Reference: + : reference/modules diff --git a/docs/tutorial/log_reg.ipynb b/docs/tutorial/log_reg.ipynb index 413d192..f122f74 100644 --- a/docs/tutorial/log_reg.ipynb +++ b/docs/tutorial/log_reg.ipynb @@ -975,7 +975,7 @@ "id": "53800467", "metadata": {}, "source": [ - "# Performance evaluations" + "## Performance evaluations" ] }, { @@ -1065,7 +1065,7 @@ "id": "a1326dcd", "metadata": {}, "source": [ - "# Multiplicative decompositon" + "## Multiplicative decompositon" ] }, { diff --git a/docs/tutorial/log_reg.py b/docs/tutorial/log_reg.py index dde7b14..3006573 100644 --- a/docs/tutorial/log_reg.py +++ b/docs/tutorial/log_reg.py @@ -522,7 +522,7 @@ # pred_bins_val # %% [markdown] -# # Performance evaluations +# ## Performance evaluations # %% prc = pd.DataFrame(results_model.train.prc, @@ -567,7 +567,7 @@ _ # %% [markdown] -# # Multiplicative decompositon +# ## Multiplicative decompositon # %% diff --git a/setup.cfg b/setup.cfg index 2bd53f6..164edb2 100644 --- a/setup.cfg +++ b/setup.cfg @@ -38,7 +38,7 @@ install_requires = docs = sphinx sphinx-book-theme - myst-parser + myst-nb [options.packages.find] where = src