Enabled building of html from jupyter notebook.

oncoray · Apr 9, 2024 · 83a7873 · 83a7873
1 parent e19e619
commit 83a7873
Show file tree

Hide file tree

Showing 3 changed files with 29 additions and 7 deletions.
diff --git a/docs_source/source/conf.py b/docs_source/source/conf.py
@@ -22,7 +22,7 @@
 author = 'Alex Zwanenburg'
 
 # The full version, including alpha/beta/rc tags
-release = '2.2.0'
+release = '2.2.1'
 
 
 # -- General configuration ---------------------------------------------------
@@ -34,7 +34,8 @@
     "sphinx.ext.napoleon",
     "sphinx.ext.autodoc",
     "sphinx.ext.viewcode",
-    "sphinx_rtd_theme"
+    "sphinx_rtd_theme",
+    "nbsphinx"
 ]
 
 # Add any paths that contain templates here, relative to this directory.

diff --git a/docs_source/source/index.rst b/docs_source/source/index.rst
@@ -1,20 +1,41 @@
-Welcome to MIRP
-===============
+Introduction
+============
 
 .. toctree::
+   :hidden:
    :maxdepth: 1
-   :caption: Contents:
+   :caption: Getting Started
 
+   index
    installation
-   quick_start
+
+.. toctree::
+   :hidden:
+   :maxdepth: 1
+   :caption: Tutorials
+
+   tutorial_compute_radiomics_features_mr
+
+.. toctree::
+   :hidden:
+   :maxdepth: 1
+   :caption: Deep Dive
+
    image_mask_import
    configuration
    image_metadata
    mask_labels
    deep_learning
    quantitative_image_analysis
+
+.. toctree::
+   :hidden:
+   :maxdepth: 1
+   :caption: Contributing
+
    contributing
 
+
 What is radiomics?
 ------------------
 

diff --git a/pyproject.toml b/pyproject.toml
@@ -41,7 +41,7 @@ Changelog = "https://github.com/oncoray/mirp/blob/master/NEWS.md"
 
 [project.optional-dependencies]
 test = ["pytest>=7.4.0"]
-docs = ["sphinx>=5.0.0", "sphinx_rtd_theme>=2.0.0"]
+docs = ["sphinx>=5.0.0", "sphinx_rtd_theme>=2.0.0", "nbsphinx"]
 
 [tool.pytest.ini_options]
 addopts = ["--strict-markers"]